masterdof.h

Go to the documentation of this file.

/*
 *
 *                 #####    #####   ######  ######  ###   ###
 *               ##   ##  ##   ##  ##      ##      ## ### ##
 *              ##   ##  ##   ##  ####    ####    ##  #  ##
 *             ##   ##  ##   ##  ##      ##      ##     ##
 *            ##   ##  ##   ##  ##      ##      ##     ##
 *            #####    #####   ##      ######  ##     ##
 *
 *
 *             OOFEM : Object Oriented Finite Element Code
 *
 *               Copyright (C) 1993 - 2013   Borek Patzak
 *
 *
 *
 *       Czech Technical University, Faculty of Civil Engineering,
 *   Department of Structural Mechanics, 166 29 Prague, Czech Republic
 *
 *  This library is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU Lesser General Public
 *  License as published by the Free Software Foundation; either
 *  version 2.1 of the License, or (at your option) any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *  Lesser General Public License for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public
 *  License along with this library; if not, write to the Free Software
 *  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 */


#ifndef masterdof_h
#define masterdof_h

#include "dof.h"
#include "dictionary.h"
#include "dofmanager.h"

#include <cstdio>

namespace oofem {
class Domain;
class DofManager;
class TimeStep;
class BoundaryCondition;
class InitialCondition;

class OOFEM_EXPORT MasterDof  : public Dof
{
protected:
    int equationNumber;
    int bc;
    int ic;
    Dictionary unknowns;

public:
    MasterDof(DofManager * aNode, int nbc, int nic, DofIDItem id);
    MasterDof(DofManager * aNode, DofIDItem id = Undef);
    virtual ~MasterDof();

    virtual dofType giveDofType() { return DT_master; }
    virtual const char *giveClassName() const { return "MasterDof"; }

    virtual int __giveEquationNumber() const;

    virtual int __givePrescribedEquationNumber();

    virtual int askNewEquationNumber(TimeStep *tStep);

    virtual double giveUnknown(ValueModeType mode, TimeStep *tStep);
    virtual double giveUnknown(PrimaryField &field, ValueModeType, TimeStep *tStep);

    virtual bool hasBc(TimeStep *tStep);
    virtual bool hasIc();
    virtual bool hasIcOn(ValueModeType);

    virtual bool isPrimaryDof() { return true; }

    virtual int giveBcId();
    virtual int giveIcId();

    virtual void printYourself();
    virtual void updateYourself(TimeStep *tStep);

    virtual void updateUnknownsDictionary(TimeStep *tStep, ValueModeType mode, double dofValue);

    virtual double giveUnknownsDictionaryValue(TimeStep *tStep, ValueModeType mode);

    virtual contextIOResultType saveContext(DataStream &stream, ContextMode mode, void *obj = NULL);
    virtual contextIOResultType restoreContext(DataStream &stream, ContextMode mode, void *obj = NULL);

    virtual void setBcId(int bcId) { this->bc = bcId; }
    virtual void setIcId(int icId) { this->ic = icId; }
    virtual void setEquationNumber(int newEquationNumber) { this->equationNumber = newEquationNumber; }
    virtual Dictionary *giveUnknowns() { return &this->unknowns; }
    virtual int giveEqn() { return equationNumber; }

protected:
    BoundaryCondition *giveBc();
    InitialCondition *giveIc();
};
} // end namespace oofem
#endif // masterdof_h