staggeredproblem.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 staggeredproblem_h
#define staggeredproblem_h

#include "engngm.h"
#include "inputrecord.h"
#include "floatarray.h"


#define _IFT_StaggeredProblem_Name "staggeredproblem"
#define _IFT_StaggeredProblem_deltat "deltat"
#define _IFT_StaggeredProblem_dtf "dtf"
#define _IFT_StaggeredProblem_timeDefinedByProb "timedefinedbyprob"
#define _IFT_StaggeredProblem_stepmultiplier "stepmultiplier"
//#define _IFT_StaggeredProblem_timeLag "timelag"
#define _IFT_StaggeredProblem_prescribedtimes "prescribedtimes"
#define _IFT_StaggeredProblem_prob1 "prob1"
#define _IFT_StaggeredProblem_prob2 "prob2"
#define _IFT_StaggeredProblem_prob3 "prob3"
#define _IFT_StaggeredProblem_coupling "coupling"
#define _IFT_StaggeredProblem_adaptiveStepLength "adaptivesteplength"
#define _IFT_StaggeredProblem_minsteplength "minsteplength"
#define _IFT_StaggeredProblem_maxsteplength "maxsteplength"
#define _IFT_StaggeredProblem_reqiterations "reqiterations"
#define _IFT_StaggeredProblem_endoftimeofinterest "endoftimeofinterest"
#define _IFT_StaggeredProblem_adaptivestepsince "adaptivestepsince"


namespace oofem {
class Function;

class OOFEM_EXPORT StaggeredProblem : public EngngModel
{
protected:
    std :: vector< std :: unique_ptr< EngngModel > >emodelList;
    double deltaT;
    std :: vector< std :: string >inputStreamNames;
    int dtFunction;
    double stepMultiplier;

    //    double timeLag;

    FloatArray discreteTimes;

    int timeDefinedByProb;

    IntArray coupledModels;
    bool adaptiveStepLength;
    double minStepLength;
    double maxStepLength;
    double reqIterations;
    double adaptiveStepSince;
    double endOfTimeOfInterest;

    double prevStepLength;
    double currentStepLength;
    

public:
    StaggeredProblem(int i, EngngModel * _master = NULL);
    virtual ~StaggeredProblem();
    StaggeredProblem(const StaggeredProblem &) = delete;
    StaggeredProblem & operator=(const StaggeredProblem &) = delete;
    void setContextOutputMode(ContextOutputMode contextMode);
    void setUDContextOutputMode(int cStep);
    void setProblemMode(problemMode pmode);
    virtual void setRenumberFlag();

    virtual void solveYourself();
    virtual void solveYourselfAt(TimeStep *tStep);
    virtual int forceEquationNumbering();
    virtual void updateYourself(TimeStep *tStep);
    virtual void initializeYourself(TimeStep *tStep) { }
    virtual int initializeAdaptive(int tStepNumber) { return 0; }
    virtual void terminate(TimeStep *tStep);
    virtual void doStepOutput(TimeStep *tStep);

    virtual int instanciateYourself(DataReader &dr, InputRecord *ir, const char *outFileName, const char *desc);
    virtual IRResultType initializeFrom(InputRecord *ir);
    virtual void updateAttributes(MetaStep *mStep);

    virtual contextIOResultType saveContext(DataStream &stream, ContextMode mode);
    virtual contextIOResultType restoreContext(DataStream &stream, ContextMode mod);
    virtual void updateDomainLinks();

    void printYourself();
    virtual void printOutputAt(FILE *file, TimeStep *tStep);

    virtual TimeStep *giveCurrentStep(bool force = false);
    virtual TimeStep *givePreviousStep(bool force = false);
    virtual TimeStep *giveSolutionStepWhenIcApply(bool force = false);
    virtual int giveNumberOfFirstStep(bool force = false);

    virtual TimeStep *giveNextStep();

    // identification
    virtual const char *giveClassName() const { return "StaggeredProblem"; }
    virtual const char *giveInputRecordName() const { return _IFT_StaggeredProblem_Name; }
    virtual int useNonlocalStiffnessOption() { return 0; }

    virtual fMode giveFormulation() { return UNKNOWN; }
    Function *giveDtFunction();

    double giveDeltaT(int n);

    double giveDiscreteTime(int n);

    void giveCoupledModels(IntArray &answer) { answer = coupledModels; }

#ifdef __OOFEG
    virtual void drawYourself(oofegGraphicContext &gc);
    virtual void drawElements(oofegGraphicContext &gc);
    virtual void drawNodes(oofegGraphicContext &gc);
    virtual void showSparseMtrxStructure(int type, oofegGraphicContext &gc, TimeStep *tStep) { }
#endif

    virtual int checkProblemConsistency();

    virtual EngngModel *giveSlaveProblem(int i);
    virtual int giveNumberOfSlaveProblems() { return (int)inputStreamNames.size(); }
    virtual int instanciateDefaultMetaStep(InputRecord *ir);

protected:
    int instanciateSlaveProblems();
};
} // end namespace oofem
#endif // staggeredproblem_h