metastep.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 metastep_h
#define metastep_h
 
#include "oofemcfg.h"
#include "inputrecord.h"
#include "floatarray.h"
#include "timestepreductionstrategy.h"
#include <memory>


#define _IFT_MetaStep_Name "metastep"
#define _IFT_MetaStep_nsteps "nsteps"
#define _IFT_MetaStep_finalT "finalt"
#define _IFT_MetaStep_deltaT "deltat"
#define _IFT_MetaStep_prescribedTimes "prescribedtimes"
#define _IFT_MetaStep_dtFunction "dtfunction" 
 
#define _IFT_MetaStep_timeReductionStrategyType "treductiontype"

 
namespace oofem {
class EngngModel;
class TimeStepReductionStrategy;

class OOFEM_EXPORT MetaStep
{
protected:
    EngngModel *eModel;
    int numberOfSteps;
    double deltaT = 1;
    double finalTime = 0;
    std::shared_ptr<InputRecord> attributes;
    int sindex;
    int number;
    FloatArray prescribedTimes;
    int dtFunction = 0;
    FloatArray discreteTimes;
    std :: string timeStepReductionStrategyType = "NoReductionStrategy";
    std :: unique_ptr<TimeStepReductionStrategy> timeStepReductionStrategy;
    double minDeltaT;
    double previousMetaStepFinalTime = 0;
    
public:
    MetaStep(int n, EngngModel * e);
    MetaStep(int n, EngngModel * e, int nsteps, InputRecord & attrib);
    MetaStep(MetaStep &&ms) = default;

    int giveNumber() { return number; }
    int giveNumberOfSteps() { return this->numberOfSteps; }
    double giveTimeIncrement() { return this->deltaT; }
    InputRecord &giveAttributesRecord() { return *this->attributes; }
    void initializeFrom(InputRecord &ir);
    int setStepBounds(int startStepNumber);
    void setNumberOfSteps(int newNumberOfSteps);
    int isStepValid(int solStepNumber);
    int giveStepRelativeNumber(int stepNumber) { return ( stepNumber - sindex + 1 ); }
    int giveFirstStepNumber() { return sindex; }
    int giveLastStepNumber() { return ( sindex + numberOfSteps - 1 ); }
    const char *giveClassName() const { return "MetaStep"; }
    int giveNumberOfMaxTimeStepReductions(){return timeStepReductionStrategy->giveNumberOfMaxTimeStepReductions();}
    double giveFinalTime(){return finalTime;}
    void setFinalTime(double ft){finalTime = ft;}
    void recomputeFinalTime(int nSteps) {finalTime =  nSteps * deltaT;}
    void setPreviousMetaStepFinalTime(double ft){previousMetaStepFinalTime = ft;}
 
 
    
    Function *giveDtFunction(){return NULL;}
    
    
    double giveDeltaT(){return this->deltaT;}
    double giveDeltaT(int n, std::unique_ptr<TimeStep> &previousStep);
   
    void setDeltaT(double dT){this->deltaT = dT;}
 
    
    double giveMinDeltaT(){return this->minDeltaT;}
    
    double giveDiscreteTime(int n){return discreteTimes.at(n);}
    void checkDiscreteTimes(){;}
    void reduceTimeStep();
    void adaptTimeStep(int nIter, double targetTime);
    void setTimeStepReductionFactor(double tStepRedFactor);
    //returns TimeStepReductionStrategy
    TimeStepReductionStrategy* giveTimeStepReductionStrategy() {return timeStepReductionStrategy.get();}
    
 
    
};
} // end namespace oofem
#endif // metastep_h