dof.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 dof_h
#define dof_h

#include <cstdio>

#include "oofemcfg.h"
#include "floatarray.h"
#include "intarray.h"
#include "unknowntype.h"
#include "valuemodetype.h"
#include "dofiditem.h"
#include "doftype.h"
#include "contextioresulttype.h"

namespace oofem {
class DataStream;
class Dictionary;
class PrimaryField;
class Domain;
class DofManager;
class TimeStep;
class BoundaryCondition;
class InitialCondition;
class UnknownNumberingScheme;
class EntityRenumberingFunctor;

class OOFEM_EXPORT Dof
{
protected:
    DofManager *dofManager;
    DofIDItem dofID;

public:

    Dof(DofManager * aNode, DofIDItem id = Undef);
    virtual ~Dof() { }

    virtual dofType giveDofType() = 0;
    virtual const char *giveClassName() const { return "Dof"; }

    int giveDofManNumber() const;

    DofManager *giveDofManager() const { return dofManager; }

    int giveDofManGlobalNumber() const;

    virtual double giveBcValue(ValueModeType mode, TimeStep *tStep);
    int giveEquationNumber(const UnknownNumberingScheme &s);
    virtual int __giveEquationNumber() const = 0;
    virtual void giveEquationNumbers(IntArray &masterEqNumbers, const UnknownNumberingScheme &s);
    virtual void giveDofIDs(IntArray &masterDofIDs);

    virtual int __givePrescribedEquationNumber() = 0;

    virtual int askNewEquationNumber(TimeStep *tStep) = 0;
    virtual double giveUnknown(ValueModeType mode, TimeStep *tStep) = 0;
    virtual double giveUnknown(PrimaryField &field, ValueModeType mode, TimeStep *tStep) = 0;
    virtual void giveUnknowns(FloatArray &masterUnknowns, ValueModeType mode, TimeStep *tStep);
    virtual void giveUnknowns(FloatArray &masterUnknowns, PrimaryField &field, ValueModeType mode, TimeStep *tStep);

    virtual void computeDofTransformation(FloatArray &masterContribs);
    virtual int giveNumberOfPrimaryMasterDofs() { return 1; }

    virtual bool hasBc(TimeStep *tStep) = 0;
    virtual bool hasIc() = 0;
    virtual bool hasIcOn(ValueModeType u) = 0;
    DofIDItem giveDofID() const { return dofID; }
    void setDofID(DofIDItem id) { this->dofID = id; }
    virtual bool isPrimaryDof() { return false; }
    virtual int giveBcId() = 0;
    virtual int giveIcId() = 0;

    virtual void giveMasterDofManArray(IntArray &answer);
    virtual void updateLocalNumbering(EntityRenumberingFunctor &f) { }

    virtual void printSingleOutputAt(FILE *file, TimeStep *tStep, char ch, ValueModeType mode, double scale = 1.0);
    virtual void printMultipleOutputAt(FILE *File, TimeStep *tStep, char *ch, ValueModeType *mode, int nite);
    void printSingleOutputWithAdditionAt(FILE *File, TimeStep *tStep, char ch, ValueModeType mode, double addend);
    virtual void printYourself();
    virtual void updateYourself(TimeStep *tStep) { }
    virtual void updateUnknownsDictionary(TimeStep *tStep, ValueModeType mode, double dofValue) { }
    virtual double giveUnknownsDictionaryValue(TimeStep *tStep, ValueModeType mode) { return 0; }

    std :: string errorInfo(const char *func) const;
    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) { }
    virtual void setIcId(int icId) { }

    virtual void setEquationNumber(int equationNumber) { }

    virtual void setUnknowns(Dictionary *unknowns) { }
    virtual Dictionary *giveUnknowns() { return NULL; }

    virtual int giveEqn() { return 0; }

    virtual int packUnknowns(DataStream &buff, ValueModeType mode, TimeStep *tStep)
    { return 1; }
    virtual int unpackAndUpdateUnknown(DataStream &buff,
                                       ValueModeType mode, TimeStep *tStep) { return 1; }

protected:
    virtual BoundaryCondition *giveBc() { return NULL; }
    virtual InitialCondition *giveIc() { return NULL; }

    friend class SimpleSlaveDof;
};
} // end namespace oofem
#endif // dof_h