OOFEM  2.4
OOFEM.org - Object Oriented Finite Element Solver
oofem::MetaStep Class Reference

Class representing meta step. More...

#include <metastep.h>

+ Collaboration diagram for oofem::MetaStep:

Public Member Functions

 MetaStep (int n, EngngModel *e)
 Constructor. More...
 
 MetaStep (int n, EngngModel *e, int nsteps, InputRecord &attrib)
 
 ~MetaStep ()
 Destructor. More...
 
int giveNumber ()
 Returns receiver's number. More...
 
int giveNumberOfSteps ()
 Returns number of Steps it represent. More...
 
double giveTimeIncrement ()
 Returns time increment. More...
 
InputRecordgiveAttributesRecord ()
 Returns e-model attributes. More...
 
IRResultType initializeFrom (InputRecord *ir)
 Instanciates the receiver from input record. More...
 
int setStepBounds (int startStepNumber)
 Sets the receiver bounds according to given solution step number, returns end index. More...
 
void setNumberOfSteps (int newNumberOfSteps)
 Sets the number of steps within the metastep. More...
 
int isStepValid (int solStepNumber)
 Tests if step number is maintained by receiver. More...
 
int giveStepRelativeNumber (int stepNumber)
 Returns the step relative number to receiver. More...
 
int giveFirstStepNumber ()
 Returns first step number. More...
 
int giveLastStepNumber ()
 Returns last step number. More...
 
const char * giveClassName () const
 Returns class name of receiver. More...
 

Protected Attributes

EngngModeleModel
 Engineering model of receiver. More...
 
int numberOfSteps
 Number of subsequent steps the receiver represent. More...
 
double deltaT
 Intrinsic time increment. More...
 
InputRecordattributes
 Engineering model attributes. More...
 
int sindex
 Start solution step number for which receiver is responsible. More...
 
int number
 Receiver number. More...
 

Detailed Description

Class representing meta step.

The meta step instance represent sequence of solution steps (timeSteps). The meta step role is to describe the common attributes related to solution steps it represent from the point of view of engineering model. For example, meta step may represent series of solution steps, for which particular solution control is used. The common attributes it represent depend on engineering model representation. To store these dependent attributes, the metaStep record (currently string) is read from input and is provided to engineering model upon request.

The meta step maintains its number, the total number of steps it represent, time increment and its e-model attributes.

Definition at line 62 of file metastep.h.

Constructor & Destructor Documentation

oofem::MetaStep::MetaStep ( int  n,
EngngModel e 
)

Constructor.

Creates a new meta step.

Parameters
nMeta step number.
eReference to corresponding engineering model.

Definition at line 38 of file metastep.C.

References attributes, eModel, number, and numberOfSteps.

oofem::MetaStep::MetaStep ( int  n,
EngngModel e,
int  nsteps,
InputRecord attrib 
)

Definition at line 46 of file metastep.C.

References attributes, eModel, oofem::InputRecord::GiveCopy(), number, and numberOfSteps.

oofem::MetaStep::~MetaStep ( )

Destructor.

Definition at line 54 of file metastep.C.

References attributes.

Member Function Documentation

const char* oofem::MetaStep::giveClassName ( ) const
inline

Returns class name of receiver.

Definition at line 113 of file metastep.h.

int oofem::MetaStep::giveFirstStepNumber ( )
inline

Returns first step number.

Definition at line 109 of file metastep.h.

Referenced by oofem::AdaptiveNonLinearStatic::assembleInitialLoadVector().

int oofem::MetaStep::giveLastStepNumber ( )
inline

Returns last step number.

Definition at line 111 of file metastep.h.

Referenced by oofem::AdaptiveNonLinearStatic::assembleInitialLoadVector(), and oofem::NonLinearStatic::updateLoadVectors().

int oofem::MetaStep::giveNumber ( )
inline
int oofem::MetaStep::giveNumberOfSteps ( )
inline
int oofem::MetaStep::giveStepRelativeNumber ( int  stepNumber)
inline

Returns the step relative number to receiver.

Definition at line 107 of file metastep.h.

Referenced by oofem::EngngModel::generateNextStep(), oofem::StaggeredProblem::solveYourself(), and oofem::EngngModel::solveYourself().

double oofem::MetaStep::giveTimeIncrement ( )
inline

Returns time increment.

Definition at line 93 of file metastep.h.

IRResultType oofem::MetaStep::initializeFrom ( InputRecord ir)

Instanciates the receiver from input record.

Definition at line 61 of file metastep.C.

References _IFT_MetaStep_nsteps, attributes, oofem::InputRecord::GiveCopy(), IR_GIVE_FIELD, oofem::IRRT_OK, and numberOfSteps.

int oofem::MetaStep::isStepValid ( int  solStepNumber)

Tests if step number is maintained by receiver.

Definition at line 88 of file metastep.C.

References numberOfSteps, and sindex.

void oofem::MetaStep::setNumberOfSteps ( int  newNumberOfSteps)

Sets the number of steps within the metastep.

Definition at line 82 of file metastep.C.

References numberOfSteps.

Referenced by oofem::MicroMaterial::setMacroProperties().

int oofem::MetaStep::setStepBounds ( int  startStepNumber)

Sets the receiver bounds according to given solution step number, returns end index.

Definition at line 74 of file metastep.C.

References numberOfSteps, and sindex.

Member Data Documentation

InputRecord* oofem::MetaStep::attributes
protected

Engineering model attributes.

Definition at line 72 of file metastep.h.

Referenced by initializeFrom(), MetaStep(), and ~MetaStep().

double oofem::MetaStep::deltaT
protected

Intrinsic time increment.

Definition at line 70 of file metastep.h.

EngngModel* oofem::MetaStep::eModel
protected

Engineering model of receiver.

Definition at line 66 of file metastep.h.

Referenced by MetaStep().

int oofem::MetaStep::number
protected

Receiver number.

Definition at line 76 of file metastep.h.

Referenced by MetaStep().

int oofem::MetaStep::numberOfSteps
protected

Number of subsequent steps the receiver represent.

Definition at line 68 of file metastep.h.

Referenced by initializeFrom(), isStepValid(), MetaStep(), setNumberOfSteps(), and setStepBounds().

int oofem::MetaStep::sindex
protected

Start solution step number for which receiver is responsible.

Definition at line 74 of file metastep.h.

Referenced by isStepValid(), and setStepBounds().


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

This page is part of the OOFEM documentation. Copyright (c) 2011 Borek Patzak
Project e-mail: info@oofem.org
Generated at Tue Jan 2 2018 20:07:38 for OOFEM by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2011