timestepcontroller.h

Go to the documentation of this file.

/*
 *
 *                 #####    #####   ######  ######  ###   ###
 *               ##   ##  ##   ##  ##      ##      ## ### ##
 *              ##   ##  ##   ##  ####    ####    ##  #  ##
 *             ##   ##  ##   ##  ##      ##      ##     ##
 *            ##   ##  ##   ##  ##      ##      ##     ##
 *            #####    #####   ##      ######  ##     ##
 *
 *
 *             OOFEM : Object Oriented Finite Element Code
 *
 *               Copyright (C) 1993 - 2025   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 timestepcontroller_h
#define timestepcontroller_h
 
 
#include "timestep.h"
#include "metastep.h"


#define _IFT_TimeStepController_nmsteps "nmsteps"
#define _IFT_TimeStepController_alpha "alpha"

 
namespace oofem {
class DataReader;
  class MetaStep;

class OOFEM_EXPORT TimeStepController
{
protected:
    int numberOfMetaSteps = 0;
    int currentMetaStepNumber = 0;
    std :: unique_ptr< TimeStep > currentStep;
    std :: unique_ptr< TimeStep > previousStep;
    EngngModel *eModel;
    virtual double giveEndOfTimeOfInterest() { return 0.; }
    int giveNumberOfTimeStepWhenIcApply() { return 0; }
    double initT = 0.;
    std :: vector< MetaStep > metaStepList;
    double alpha = 1.0; 
public:
     TimeStepController(EngngModel *e){eModel = e;}
    const char *giveClassName() const { return "TimeStepController"; }
 

    virtual TimeStep *giveCurrentStep() {
      return currentStep.get();
      
    }

    virtual TimeStep *givePreviousStep() {
        return previousStep.get();
    }

    //virtual TimeStep giveNextStep();
    virtual TimeStep* giveNextStep();
 
 
    TimeStep* generateNextStep(){return NULL;}
 
    
 
    
    void initializeFrom(InputRecord &ir);
    void saveContext(DataStream &stream);
    void restoreContext(DataStream &stream);
    //functions copied from engng
    int giveNumberOfMetaSteps() { return numberOfMetaSteps; }
    MetaStep *giveMetaStep(int i);
 
    int instanciateDefaultMetaStep(InputRecord &ir);
    int instanciateMetaSteps(DataReader &dr);
    void initMetaStepAttributes(MetaStep *mStep);
    int giveMetaStepNumber(){return 1;}
    void postInitialize();
    void reduceTimeStep();
    void adaptTimeStep(int nIter);
    //@todo improve: return number of steps of the current metastep
    int giveNumberOfSteps(){return this->giveCurrentMetaStep()->giveNumberOfSteps();}
 
    
    int giveFinalTime(){return 0;}
    double giveDeltaT(){return this->giveCurrentMetaStep()->giveDeltaT();}
    double giveMinDeltaT(){return this->giveCurrentMetaStep()->giveMinDeltaT();}
    void setDeltaT(double dT){return this->giveCurrentMetaStep()->setDeltaT(dT);}
    MetaStep *giveCurrentMetaStep(){return &metaStepList.at(currentMetaStepNumber);}
    void setCurrentMetaStepNumber(int smstep){currentMetaStepNumber = smstep;}
 
protected:
//  double finalTime = 0;
 
 
};
} // end namespace oofem
#endif // timestepcontroller_h