timestep.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
 */
/*
 * The original idea for this class comes from
 * Dubois-Pelerin, Y.: "Object-Oriented  Finite Elements: Programming concepts and Implementation",
 * PhD Thesis, EPFL, Lausanne, 1992.
 */

#ifndef timestep_h
#define timestep_h

#include "oofemcfg.h"
#include "contextioresulttype.h"
#include "contextmode.h"
#include "statecountertype.h"
#include "timediscretizationtype.h"
#include "inputrecord.h"

namespace oofem {
class EngngModel;
class DataStream;

class OOFEM_EXPORT TimeStep
{
protected:
    EngngModel *eModel;
    double targetTime;
    double intrinsicTime;
    double deltaT;
    StateCounterType solutionStateCounter;
    int number;
    int version;
    int subStepNumber;
    int mStepNumber;
    TimeDiscretizationType timeDiscretization;

public:
    TimeStep(int n, EngngModel * e, int mn, double tt, double dt, StateCounterType counter, TimeDiscretizationType td = TD_Unspecified);
    TimeStep(const TimeStep &);
    TimeStep(const TimeStep &previous, double dt);
    TimeStep(EngngModel * e);
    TimeStep &operator = ( const TimeStep & );

    int giveNumber() { return number; }
    void setNumber(int i) { number = i; }
    int giveVersion() { return version; }
    int giveMetaStepNumber() { return mStepNumber; }
    int giveSubStepNumber() { return subStepNumber; }
    const char *giveClassName() const { return "TimeStep"; }
    TimeStep *givePreviousStep();
    double giveTargetTime() { return targetTime; }
    double giveIntrinsicTime() { return intrinsicTime; }
    double giveTimeIncrement() { return deltaT; }
    void setTimeIncrement(double newDt) { deltaT = newDt; }
    void setTime(double newt) {
        targetTime = newt;
        intrinsicTime = newt;
    }
    void setTargetTime(double newt) { targetTime = newt; }
    void setIntrinsicTime(double newt) { intrinsicTime = newt; }
    void setTimeDiscretization(TimeDiscretizationType td) { timeDiscretization = td; }

    bool isNotTheLastStep();
    bool isTheFirstStep();
    bool isTheCurrentTimeStep();
    bool isIcApply();
    StateCounterType giveSolutionStateCounter() { return solutionStateCounter; }
    void incrementStateCounter() { solutionStateCounter++; }
    void incrementVersion() { version++; }
    void incrementSubStepNumber() { subStepNumber++; }
    TimeDiscretizationType giveTimeDiscretization() { return timeDiscretization; }

    IRResultType initializeFrom(InputRecord *ir) { return IRRT_OK; }
    contextIOResultType saveContext(DataStream &stream, ContextMode mode, void *obj = NULL);
    contextIOResultType restoreContext(DataStream &stream, ContextMode mode, void *obj = NULL);

    std :: string errorInfo(const char *func) { return std :: string("TimeStep::") + func; }
};
} // end namespace oofem
#endif // timestep_h