OOFEM 3.0
Loading...
Searching...
No Matches
oofem::ProblemSequence Class Reference

#include <problemsequence.h>

Inheritance diagram for oofem::ProblemSequence:
Collaboration diagram for oofem::ProblemSequence:

Public Member Functions

 ProblemSequence (int i, EngngModel *master=nullptr)
 Constructor.
virtual ~ProblemSequence ()
 Destructor.
 ProblemSequence (const ProblemSequence &)=delete
ProblemSequenceoperator= (const ProblemSequence &)=delete
EngngModelgiveActiveModel ()
void solveYourself () override
int instanciateYourself (DataReader &dr, InputRecord &ir, const char *outFileName, const char *desc) override
void initializeFrom (InputRecord &ir) override
int checkProblemConsistency () override
void saveContext (DataStream &stream, ContextMode mode) override
void restoreContext (DataStream &stream, ContextMode mode) override
const char * giveClassName () const override
 Returns class name of the receiver.
const char * giveInputRecordName () const
void drawYourself (oofegGraphicContext &gc) override
void drawElements (oofegGraphicContext &gc) override
void drawNodes (oofegGraphicContext &gc) override
void showSparseMtrxStructure (int type, oofegGraphicContext &gc, TimeStep *tStep) override
EngngModelgiveSlaveProblem (int i) override
 Returns i-th slave problem.
int giveNumberOfSlaveProblems () override
 Returns number of slave problems.
int instanciateDefaultMetaStep (InputRecord &ir) override
 Instanciate default metastep, if nmsteps is zero.
 EngngModel (int i, EngngModel *_master=NULL)
virtual ~EngngModel ()
 Destructor.
 EngngModel (const EngngModel &)=delete
EngngModeloperator= (const EngngModel &)=delete
DomaingiveDomain (int n)
void setDomain (int i, Domain *ptr, bool iDeallocateOld=true)
int giveNumberOfDomains ()
 Returns number of domains in problem.
const std::string & giveDescription () const
const time_t & giveStartTime ()
bool giveSuppressOutput () const
virtual ErrorEstimatorgiveDomainErrorEstimator (int n)
virtual MaterialInterfacegiveMaterialInterface (int n)
void setNumberOfEquations (int id, int neq)
FILE * giveOutputStream ()
 Returns file descriptor of output file.
std::string giveOutputBaseFileName ()
std::string giveReferenceFileName ()
void letOutputBaseFileNameBe (const std ::string &src)
ContextOutputMode giveContextOutputMode () const
int giveContextOutputStep () const
void setContextOutputMode (ContextOutputMode contextMode)
void setUDContextOutputMode (int cStep)
double giveDeltaT ()
 Returns time step size from the time step controlelr.
void setDeltaT (double dT)
 Returns time step size through the time step controlelr.
void setProblemMode (problemMode pmode)
void setParallelMode (bool newParallelFlag)
problemMode giveProblemMode () const
 Returns domain mode.
void setProblemScale (problemScale pscale)
problemScale giveProblemScale () const
 Returns scale in multiscale simulation.
virtual void setRenumberFlag ()
 Sets the renumber flag to true.
virtual void resetRenumberFlag ()
 Sets the renumber flag to false.
double giveSolutionStepTime ()
void giveAnalysisTime (int &rhrs, int &rmin, int &rsec, int &uhrs, int &umin, int &usec)
void terminateAnalysis ()
virtual void restartYourself (TimeStep *tS)
virtual void solveYourselfAt (TimeStep *tStep)
virtual void terminate (TimeStep *tStep)
virtual void doStepOutput (TimeStep *tStep)
void saveStepContext (TimeStep *tStep, ContextMode mode)
virtual void updateYourself (TimeStep *tStep)
virtual void initializeYourself (TimeStep *tStep)
virtual int initializeAdaptive (int tStepNumber)
virtual int giveNumberOfDomainEquations (int di, const UnknownNumberingScheme &num)
virtual double giveUnknownComponent (ValueModeType, TimeStep *, Domain *, Dof *)
virtual FieldPtr giveField (FieldType key, TimeStep *)
virtual FieldPtr giveField (InternalStateType key, TimeStep *)
EngngModelgiveMasterEngngModel ()
 Returns the master engnmodel.
virtual double giveLoadLevel ()
 Returns the current load level.
virtual double giveEigenValue (int eigNum)
 Only relevant for eigen value analysis. Otherwise returns zero.
virtual void setActiveVector (int i)
 Only relevant for eigen value analysis. Otherwise does noting.
int updateSharedDofManagers (FloatArray &answer, const UnknownNumberingScheme &s, int ExchangeTag)
int exchangeRemoteElementData (int ExchangeTag)
virtual int giveCurrentNumberOfIterations ()
MPI_Comm giveParallelComm ()
 Returns the communication object of reciever.
int packRemoteElementData (ProcessCommunicator &processComm)
int unpackRemoteElementData (ProcessCommunicator &processComm)
int packDofManagers (ArrayWithNumbering *src, ProcessCommunicator &processComm)
int unpackDofManagers (ArrayWithNumbering *dest, ProcessCommunicator &processComm)
ProblemCommunicatorgiveProblemCommunicator (EngngModelCommType t)
void initializeCommMaps (bool forceInit=false)
void Instanciate_init ()
int instanciateDomains (DataReader &dr)
 Instanciate problem domains by calling their instanciateYourself() service.
int instanciateMetaSteps (DataReader &dr)
 Instanciate problem meta steps by calling their instanciateYourself() service.
virtual void updateAttributes (MetaStep *mStep)
void initMetaStepAttributes (MetaStep *mStep)
virtual void updateDomainLinks ()
MetaStepgiveCurrentMetaStep ()
 Returns current meta step.
virtual TimeStepgiveCurrentStep (bool force=false)
virtual void adaptTimeStep (double nIter)
virtual TimeStepgivePreviousStep (bool force=false)
virtual TimeStepgiveNextStep ()
 Returns next time step (next to current step) of receiver.
virtual void preInitializeNextStep ()
 Does a pre-initialization of the next time step (implement if necessarry).
virtual TimeStepgiveSolutionStepWhenIcApply (bool force=false)
virtual int giveNumberOfFirstStep (bool force=false)
int giveNumberOfMetaSteps ()
 Return number of meta steps.
MetaStepgiveMetaStep (int i)
 Returns the i-th meta step.
int giveNumberOfSteps (bool force=false)
virtual double giveEndOfTimeOfInterest ()
 Returns end of time interest (time corresponding to end of time integration).
int giveNumberOfTimeStepWhenIcApply ()
 Returns the time step number, when initial conditions should apply.
virtual NumericalMethodgiveNumericalMethod (MetaStep *mStep)
 Returns reference to receiver's numerical method.
ExportModuleManagergiveExportModuleManager ()
 Returns receiver's export module manager.
EngngModelTimergiveTimer ()
 Returns reference to receiver timer (EngngModelTimer).
virtual double giveInitialTime ()
 return time at the begining of analysis
virtual double giveFinalTime ()
virtual int giveNewEquationNumber (int domain, DofIDItem)
virtual int giveNewPrescribedEquationNumber (int domain, DofIDItem)
std::string giveContextFileName (int tStepNumber, int stepVersion) const
std::string giveDomainFileName (int domainNum, int domainSerNum) const
virtual void updateComponent (TimeStep *tStep, NumericalCmpn cmpn, Domain *d)
virtual void initForNewIteration (Domain *d, TimeStep *tStep, int iterationNumber, const FloatArray &solution)
virtual void updateSolution (FloatArray &solutionVector, TimeStep *tStep, Domain *d)
virtual void updateInternalRHS (FloatArray &answer, TimeStep *tStep, Domain *d, FloatArray *eNorm)
virtual void updateMatrix (SparseMtrx &mat, TimeStep *tStep, Domain *d)
virtual void initStepIncrements ()
virtual int forceEquationNumbering (int i)
virtual int forceEquationNumbering ()
virtual int requiresUnknownsDictionaryUpdate ()
virtual bool requiresEquationRenumbering (TimeStep *tStep)
virtual void updateDofUnknownsDictionary (DofManager *, TimeStep *)
virtual int giveUnknownDictHashIndx (ValueModeType mode, TimeStep *tStep)
virtual bool newDofHandling ()
virtual ParallelContextgiveParallelContext (int n)
virtual void initParallelContexts ()
virtual void assemble (SparseMtrx &answer, TimeStep *tStep, const MatrixAssembler &ma, const UnknownNumberingScheme &s, Domain *domain)
virtual void assemble (SparseMtrx &answer, TimeStep *tStep, const MatrixAssembler &ma, const UnknownNumberingScheme &r_s, const UnknownNumberingScheme &c_s, Domain *domain)
void assembleVector (FloatArray &answer, TimeStep *tStep, const VectorAssembler &va, ValueModeType mode, const UnknownNumberingScheme &s, Domain *domain, FloatArray *eNorms=NULL)
void assembleVectorFromDofManagers (FloatArray &answer, TimeStep *tStep, const VectorAssembler &va, ValueModeType mode, const UnknownNumberingScheme &s, Domain *domain, FloatArray *eNorms=NULL)
void assembleVectorFromElements (FloatArray &answer, TimeStep *tStep, const VectorAssembler &va, ValueModeType mode, const UnknownNumberingScheme &s, Domain *domain, FloatArray *eNorms=NULL)
void assembleVectorFromBC (FloatArray &answer, TimeStep *tStep, const VectorAssembler &va, ValueModeType mode, const UnknownNumberingScheme &s, Domain *domain, FloatArray *eNorms=NULL)
void assembleExtrapolatedForces (FloatArray &answer, TimeStep *tStep, CharType type, Domain *domain)
void assemblePrescribedExtrapolatedForces (FloatArray &answer, TimeStep *tStep, CharType type, Domain *domain)
virtual int checkConsistency ()
virtual void init ()
virtual void postInitialize ()
virtual void printOutputAt (FILE *file, TimeStep *tStep)
virtual void printOutputAt (FILE *file, TimeStep *tStep, const IntArray &nodeSets, const IntArray &elementSets)
void outputNodes (FILE *file, Domain &domain, TimeStep *tStep, int setNum)
void outputElements (FILE *file, Domain &domain, TimeStep *tStep, int setNum)
void printYourself ()
 Prints state of receiver. Useful for debugging.
virtual void printDofOutputAt (FILE *stream, Dof *iDof, TimeStep *tStep)
virtual int useNonlocalStiffnessOption ()
 Returns nonzero if nonlocal stiffness option activated.
bool isParallel () const
 Returns true if receiver in parallel mode.
int giveRank () const
 Returns domain rank in a group of collaborating processes (0..groupSize-1).
int giveNumberOfProcesses () const
 Returns the number of collaborating processes.
virtual fMode giveFormulation ()
EngngModelContextgiveContext ()
 Context requesting service.
virtual bool giveEquationScalingFlag ()
 Returns the Equation scaling flag, which is used to indicate that governing equation(s) are scaled, or non-dimensionalized.
virtual double giveVariableScale (VarScaleType varId)
 Returns the scale factor for given variable type.
virtual int estimateMaxPackSize (IntArray &commMap, DataStream &buff, int packUnpackType)
virtual void balanceLoad (TimeStep *tStep)
virtual LoadBalancergiveLoadBalancer ()
virtual LoadBalancerMonitorgiveLoadBalancerMonitor ()
void initParallel ()
 Request domain rank and problem size.
EngngModelgiveEngngModel ()
 Returns reference to itself -> required by communicator.h.
virtual bool isElementActivated (int elemNum)
virtual bool isElementActivated (Element *e)
TimeStepControllergiveTimeStepController ()
 Returns the time step controller.
std::string errorInfo (const char *func) const
 Returns string for prepending output (used by error reporting macros).

Protected Attributes

std ::vector< std ::unique_ptr< EngngModel > > emodelList
 List of engineering models to solve sequentially.
std ::vector< std ::string > inputStreamNames
int activeModel
 Keeps track of the active model in the analysis sequence.
Protected Attributes inherited from oofem::EngngModel
int ndomains
 Number of receiver domains.
std ::vector< std ::unique_ptr< Domain > > domainList
 List of problem domains.
int numberOfSteps
 Total number of time steps.
int numberOfEquations
 Total number of equation in current time step.
int numberOfPrescribedEquations
 Total number or prescribed equations in current time step.
IntArray domainNeqs
 Number of equations per domain.
IntArray domainPrescribedNeqs
 Number of prescribed equations per domain.
bool renumberFlag
 Renumbering flag (renumbers equations after each step, necessary if Dirichlet BCs change).
bool profileOpt
 Profile optimized numbering flag (using Sloan's algorithm).
int equationNumberingCompleted
 Equation numbering completed flag.
int nMetaSteps
 Number of meta steps.
std ::vector< MetaStepmetaStepList
 List of problem metasteps.
std ::unique_ptr< TimeStepstepWhenIcApply
 Solution step when IC (initial conditions) apply.
std ::unique_ptr< TimeStepcurrentStep
 Current time step.
std ::unique_ptr< TimeSteppreviousStep
 Previous time step.
int number
 Receivers id.
std::string dataOutputFileName
 Path to output stream.
std::string coreOutputFileName
 String with core output file name.
FILE * outputStream
 Output stream.
std::string referenceFileName
 String with reference file name.
ContextOutputMode contextOutputMode
 Domain context output mode.
int contextOutputStep
ExportModuleManager exportModuleManager
 Export module manager.
InitModuleManager initModuleManager
 Initialization module manager.
MonitorManager monitorManager
 Monitor manager.
problemMode pMode
 Domain mode.
problemScale pScale
 Multiscale mode.
time_t startTime
 Solution start time.
EngngModelmaster
 Master e-model; if defined receiver is in maintained (slave) mode.
EngngModelContextcontext
 Context.
EngngModelTimer timer
 E-model timer.
int parallelFlag
 Flag indicating that the receiver runs in parallel.
enum fMode nonLinFormulation
 Type of non linear formulation (total or updated formulation).
std::unique_ptr< ErrorEstimatordefaultErrEstimator
 Error estimator. Useful for adaptivity, or simply printing errors output.
std::unique_ptr< TimeStepControllertimeStepController
 Time Step controller is responsible for collecting data from analysis, elements, and materials, and select the appropriate timestep size for the next step, or reduce the step in case of convergence problems.
int rank
 Domain rank in a group of collaborating processes (0..groupSize-1).
int numProcs
 Total number of collaborating processes.
int nonlocalExt
 Flag indicating if nonlocal extension active, which will cause data to be sent between shared elements before computing the internal forces.
char processor_name [PROCESSOR_NAME_LENGTH]
 Processor name.
MPI_Comm comm
 Communication object for this engineering model.
std::unique_ptr< LoadBalancerlb
 Load Balancer.
std::unique_ptr< LoadBalancerMonitorlbm
bool loadBalancingFlag
 If set to true, load balancing is active.
bool force_load_rebalance_in_first_step
 Debug flag forcing load balancing after first step.
CommunicatorBuffcommBuff
 Common Communicator buffer.
ProblemCommunicatorcommunicator
 Communicator.
ProblemCommunicatornonlocCommunicator
 NonLocal Communicator. Necessary when nonlocal constitutive models are used.
std ::vector< ParallelContextparallelContextList
 List where parallel contexts are stored.
bool suppressOutput
 Flag for suppressing output to file.
std::string simulationDescription

Additional Inherited Members

Public Types inherited from oofem::EngngModel
enum  EngngModel_UpdateMode { EngngModel_Unknown_Mode , EngngModel_SUMM_Mode , EngngModel_SET_Mode }
enum  EngngModelCommType { PC_default , PC_nonlocal }
enum  InitialGuess { IG_None = 0 , IG_Tangent = 1 }
Protected Types inherited from oofem::EngngModel
enum  {
  InternalForcesExchangeTag , MassExchangeTag , LoadExchangeTag , ReactionExchangeTag ,
  RemoteElementExchangeTag
}
 Message tags. More...
virtual void packMigratingData (TimeStep *tStep)
virtual void unpackMigratingData (TimeStep *tStep)

Detailed Description

Meta-engineering problem used to solve a sequence off different problems, all using the same domain. For example, a static deformation followed

Todo
This class is far from finished and is still lacking vital functionality. It does not work yet.
Author
Mikael Öhman

Definition at line 58 of file problemsequence.h.

Constructor & Destructor Documentation

◆ ProblemSequence() [1/2]

oofem::ProblemSequence::ProblemSequence ( int i,
EngngModel * master = nullptr )

◆ ~ProblemSequence()

oofem::ProblemSequence::~ProblemSequence ( )
virtual

Destructor.

Definition at line 51 of file problemsequence.C.

◆ ProblemSequence() [2/2]

oofem::ProblemSequence::ProblemSequence ( const ProblemSequence & )
delete

References ProblemSequence().

Member Function Documentation

◆ checkProblemConsistency()

int oofem::ProblemSequence::checkProblemConsistency ( )
overridevirtual

Allows programmer to test problem its internal data, before computation begins.

Returns
Nonzero if receiver check is o.k.

Reimplemented from oofem::EngngModel.

Definition at line 93 of file problemsequence.C.

References emodelList.

◆ drawElements()

void oofem::ProblemSequence::drawElements ( oofegGraphicContext & gc)
overridevirtual

Reimplemented from oofem::EngngModel.

Definition at line 129 of file problemsequence.C.

References gc.

◆ drawNodes()

void oofem::ProblemSequence::drawNodes ( oofegGraphicContext & gc)
overridevirtual

Reimplemented from oofem::EngngModel.

Definition at line 130 of file problemsequence.C.

References gc.

◆ drawYourself()

void oofem::ProblemSequence::drawYourself ( oofegGraphicContext & gc)
overridevirtual

Reimplemented from oofem::EngngModel.

Definition at line 128 of file problemsequence.C.

References gc.

◆ giveActiveModel()

EngngModel & oofem::ProblemSequence::giveActiveModel ( )
inline

Definition at line 77 of file problemsequence.h.

References activeModel, emodelList, and oofem::EngngModel::EngngModel().

◆ giveClassName()

const char * oofem::ProblemSequence::giveClassName ( ) const
inlineoverridevirtual

Returns class name of the receiver.

Implements oofem::EngngModel.

Definition at line 90 of file problemsequence.h.

◆ giveInputRecordName()

const char * oofem::ProblemSequence::giveInputRecordName ( ) const
inline

Definition at line 91 of file problemsequence.h.

References _IFT_ProblemSequence_Name.

◆ giveNumberOfSlaveProblems()

int oofem::ProblemSequence::giveNumberOfSlaveProblems ( )
inlineoverridevirtual

Returns number of slave problems.

Reimplemented from oofem::EngngModel.

Definition at line 101 of file problemsequence.h.

◆ giveSlaveProblem()

EngngModel * oofem::ProblemSequence::giveSlaveProblem ( int i)
inlineoverridevirtual

Returns i-th slave problem.

Reimplemented from oofem::EngngModel.

Definition at line 100 of file problemsequence.h.

References oofem::EngngModel::EngngModel().

◆ initializeFrom()

void oofem::ProblemSequence::initializeFrom ( InputRecord & ir)
overridevirtual

Initializes receiver according to object description in input reader. InitString can be imagined as data record in component database belonging to receiver. Receiver may use value-name extracting functions to extract particular field from record.

Reimplemented from oofem::EngngModel.

Definition at line 85 of file problemsequence.C.

References _IFT_ProblemSequence_engineeringModels, inputStreamNames, and IR_GIVE_FIELD.

◆ instanciateDefaultMetaStep()

int oofem::ProblemSequence::instanciateDefaultMetaStep ( InputRecord & ir)
inlineoverridevirtual

Instanciate default metastep, if nmsteps is zero.

Reimplemented from oofem::EngngModel.

Definition at line 103 of file problemsequence.h.

◆ instanciateYourself()

int oofem::ProblemSequence::instanciateYourself ( DataReader & dr,
InputRecord & ir,
const char * outFileName,
const char * desc )
overridevirtual

Initializes whole problem according to its description stored in inputStream. Prints header, opens the outFileName, instanciate itself the receiver using using virtual initializeFrom service and instanciates all problem domains.

Reimplemented from oofem::EngngModel.

Definition at line 67 of file problemsequence.C.

References oofem::EngngModel::contextOutputMode, oofem::EngngModel::dataOutputFileName, emodelList, oofem::InputRecord::finish(), inputStreamNames, oofem::InstanciateProblem(), and oofem::EngngModel::pMode.

◆ operator=()

ProblemSequence & oofem::ProblemSequence::operator= ( const ProblemSequence & )
delete

References ProblemSequence().

◆ restoreContext()

void oofem::ProblemSequence::restoreContext ( DataStream & stream,
ContextMode mode )
overridevirtual

Restores the state of model from output stream. Restores not only the receiver state, but also same function is invoked for all DofManagers and Elements in associated domain. Note that by restoring element context also contexts of all associated integration points (and material statuses) are restored. Each context is associated with unique time step. Only one context per time step is allowed. Restore context function will restore such context, which is related (through its step number) to time step number and version given in obj parameter. Restoring context will change current time step in order to correspond to newly restored context.

Parameters
streamContext file.
modeDetermines amount of info in stream.
Exceptions
ContextIOERRexception if error encountered.

Reimplemented from oofem::EngngModel.

Definition at line 115 of file problemsequence.C.

References activeModel, emodelList, and oofem::DataStream::read().

◆ saveContext()

void oofem::ProblemSequence::saveContext ( DataStream & stream,
ContextMode mode )
overridevirtual

Stores the state of model to output stream. Stores not only the receiver state, but also same function is invoked for all DofManagers and Elements in associated domain. Note that by storing element context also contexts of all associated integration points (and material statuses) are stored.

Parameters
streamContext stream.
modeDetermines amount of info in stream.
Exceptions
ContextIOERRIf error encountered.

Reimplemented from oofem::EngngModel.

Definition at line 103 of file problemsequence.C.

References activeModel, emodelList, and oofem::DataStream::write().

◆ showSparseMtrxStructure()

void oofem::ProblemSequence::showSparseMtrxStructure ( int type,
oofegGraphicContext & gc,
TimeStep * tStep )
inlineoverridevirtual

Shows the sparse structure of required matrix, type == 1 stiffness.

Reimplemented from oofem::EngngModel.

Definition at line 97 of file problemsequence.h.

References gc.

◆ solveYourself()

void oofem::ProblemSequence::solveYourself ( )
overridevirtual

Starts solution process. Implementation should invoke for each time step solveYourselfAt function with time step as parameter. Time steps are created using giveNextStep function (this will set current time step to newly created, and updates previous step).

Todo
Still lacking the all important code to connect the subsequent analysis!

Reimplemented from oofem::EngngModel.

Definition at line 54 of file problemsequence.C.

References emodelList.

Member Data Documentation

◆ activeModel

int oofem::ProblemSequence::activeModel
protected

Keeps track of the active model in the analysis sequence.

Definition at line 66 of file problemsequence.h.

Referenced by giveActiveModel(), restoreContext(), and saveContext().

◆ emodelList

std :: vector< std :: unique_ptr< EngngModel > > oofem::ProblemSequence::emodelList
protected

List of engineering models to solve sequentially.

Definition at line 62 of file problemsequence.h.

Referenced by checkProblemConsistency(), giveActiveModel(), instanciateYourself(), restoreContext(), saveContext(), and solveYourself().

◆ inputStreamNames

std :: vector< std :: string > oofem::ProblemSequence::inputStreamNames
protected

Definition at line 63 of file problemsequence.h.

Referenced by initializeFrom(), and instanciateYourself().


The documentation for this class was generated from the following files:

This page is part of the OOFEM-3.0 documentation. Copyright Copyright (C) 1994-2025 Borek Patzak Bořek Patzák
Project e-mail: oofem@fsv.cvut.cz
Generated at for OOFEM by doxygen 1.15.0 written by Dimitri van Heesch, © 1997-2011