Class representing solution step. More...

#include <timestep.h>

Collaboration diagram for oofem::TimeStep:

Public Member Functions
	TimeStep (int n, EngngModel *e, int mn, double tt, double dt, StateCounterType counter, TimeDiscretizationType td=TD_Unspecified)
	Creates a new solution step.
	TimeStep (const TimeStep &)
	TimeStep (EngngModel *e)
TimeStep &	operator= (const TimeStep &)
int	giveNumber ()
	Returns receiver's number.
void	setNumber (int i)
	Set receiver's number.
int	giveVersion ()
	Returns receiver's version.
int	giveMetaStepNumber ()
	Returns receiver's meta step number.
const char *	giveClassName () const
	Returns class name of receiver.
TimeStep *	givePreviousStep ()
	Returns pointer to previous solution step.
double	giveTargetTime ()
	Returns target time.
double	giveIntrinsicTime ()
	Returns intrinsic time, e.g. time in which constitutive model is evaluated.
double	giveTimeIncrement ()
	Returns solution step associated time increment.
void	setTimeIncrement (double newDt)
	Sets solution step time increment.
void	setTime (double newt)
	Sets target and intrinsic time to be equal.
void	setTargetTime (double newt)
	Sets only target time.
void	setIntrinsicTime (double newt)
	Sets only intrinsic time.
void	setTimeDiscretization (TimeDiscretizationType td)
	Sets time discretization.
bool	isNotTheLastStep ()
	Check if solution step is not the last step.
bool	isTheFirstStep ()
	Check if receiver is first step.
bool	isTheCurrentTimeStep ()
	Check if receiver is current solution step.
bool	isIcApply ()
	Check if receiver is solution step when initial conditions should apply.
StateCounterType	giveSolutionStateCounter ()
	Returns current solution state counter.
void	incrementStateCounter ()
	Updates solution state counter.
void	incrementVersion ()
	Increments receiver's version.
TimeDiscretizationType	giveTimeDiscretization ()
	Returns time discretization.
IRResultType	initializeFrom (InputRecord *ir)
contextIOResultType	saveContext (DataStream stream, ContextMode mode, void obj=NULL)
	Stores receiver state to output stream.
contextIOResultType	restoreContext (DataStream stream, ContextMode mode, void obj=NULL)
	Restores the receiver state previously written in stream.
Protected Attributes
EngngModel *	eModel
	Engineering model reference.
double	targetTime
	Current target time, which represents time at the end of a time step.
double	intrinsicTime
	Current intrinsic time, which may represents imposing time of boundary condition or time entering constitutive laws.
double	deltaT
	Current intrinsic time increment.
StateCounterType	solutionStateCounter
	Solution state counter.
int	number
	Receiver's number.
int	version
	Receiver's version, used for special applications; default set to 0.
int	mstepNumber
	Corresponding meta step number.
TimeDiscretizationType	timeDiscretization
	Time discretization.

Detailed Description

Class representing solution step.

The timeStep instance may represent either time step, load increment, or load case depending on used Engineering model. See corresponding EngngModel reference for details. TimeStep maintains a reference to corresponding Engineering model class instance.

The class hold target time, which may represent the end of time interval. In addition, there is intrinsic time, which is normally set the same as target time. Intrinsic (assembly) time is used especially in constitutive laws, where the material law is not meant to be evaluated at target time. Also, imposing boundary conditions occurs at intrinsic time by default. This reflects changes of static system and proper equation numbering during each timeStep.

Some components (typically integration points real stresses or integration points nonlocal values) are computationally very demanding. Because in typical code, there are number of requests for same value during the computation process, it may be efficient to store these values and compute them only once. The principal problem is to recognize, when is necessary to re-compute these stored values to reflect newly reached state. This cannot be determined form solution step "time", because solution step may represent for example load increment, inside which typically many iterations are needed to reach convergence. For this purpose, a concept of solution state counters is provided. Whenever the solution state changes, the engineering model updates the solution state counter. The solution state counter is guaranteed to grow up smoothly (it newer decreases) during solution process. Other components of program (integration points) can then store their computationally expensive values but have to store also corresponding solution state counter value valid when these were computed. Then, easy check is done for finding differences between frozen solution state counter and their value with current solution state requested from solution step and recompute the values if necessary.

Definition at line 78 of file timestep.h.

Constructor & Destructor Documentation

oofem::TimeStep::TimeStep	(	int	n,
		EngngModel *	e,
		int	mn,
		double	tt,
		double	dt,
		StateCounterType	counter,
		TimeDiscretizationType	td = `TD_Unspecified`
	)

Creates a new solution step.

Parameters:

n	Solution step number.
e	Reference to corresponding engng model.
mn	Meta step number.
tt	Intrinsic time.
dt	Intrinsic time increment.
counter	Solution state counter.
td	Time discretization.

Definition at line 48 of file timestep.C.

oofem::TimeStep::TimeStep ( const TimeStep & src )

Definition at line 67 of file timestep.C.

References deltaT, eModel, intrinsicTime, mstepNumber, number, solutionStateCounter, targetTime, and version.

oofem::TimeStep::TimeStep ( EngngModel * e )

Definition at line 55 of file timestep.C.

References deltaT, eModel, intrinsicTime, mstepNumber, number, solutionStateCounter, targetTime, and version.

Member Function Documentation

const char* oofem::TimeStep::giveClassName ( ) const [inline]

Returns class name of receiver.

Returns:: Pointer to s parameter filled with name.

Definition at line 132 of file timestep.h.

double oofem::TimeStep::giveIntrinsicTime ( ) [inline]

Returns intrinsic time, e.g. time in which constitutive model is evaluated.

Definition at line 138 of file timestep.h.

References intrinsicTime.

Referenced by oofem::MacroLSpace::computeStiffnessMatrix(), oofem::StructuralMaterial::computeStressIndependentStrainVector(), oofem::VTKXMLExportModule::doOutput(), oofem::LoadTimeFunction::evaluate(), oofem::MacroLSpace::giveInternalForcesVector(), oofem::HydratingConcreteMatStatus::GivePower(), oofem::Material::isActivated(), oofem::HydratingConcreteMatStatus::printOutputAt(), oofem::NonLinearStatic::proceedStep(), and oofem::HydratingConcreteMatStatus::updateYourself().

int oofem::TimeStep::giveMetaStepNumber ( ) [inline]

Returns receiver's meta step number.

Definition at line 127 of file timestep.h.

References mstepNumber.

Referenced by oofem::AdaptiveNonLinearStatic::assembleInitialLoadVector(), oofem::NonLinearStatic::giveNextStep(), oofem::NonLinearDynamic::giveNextStep(), oofem::NonLinearStatic::proceedStep(), oofem::EngngModel::restoreContext(), oofem::HuertaErrorEstimator::setupRefinedProblemProlog(), oofem::StaggeredProblem::solveYourself(), oofem::EngngModel::solveYourself(), oofem::NLTransientTransportProblem::solveYourselfAt(), oofem::LinearStatic::solveYourselfAt(), oofem::EigenValueDynamic::solveYourselfAt(), oofem::StokesFlow::solveYourselfAt(), oofem::LinearStability::solveYourselfAt(), oofem::NonLinearStatic::updateComponent(), and oofem::NonLinearStatic::updateLoadVectors().

int oofem::TimeStep::giveNumber ( ) [inline]

Returns receiver's number.

Definition at line 121 of file timestep.h.

References number.

TimeStep * oofem::TimeStep::givePreviousStep ( )

Returns pointer to previous solution step.

Definition at line 97 of file timestep.C.

References eModel, oofem::EngngModel::givePreviousStep(), isTheCurrentTimeStep(), and OOFEM_ERROR.

StateCounterType oofem::TimeStep::giveSolutionStateCounter ( ) [inline]

Returns current solution state counter.

Definition at line 175 of file timestep.h.

References solutionStateCounter.

double oofem::TimeStep::giveTargetTime ( ) [inline]

Returns target time.

Definition at line 136 of file timestep.h.

References targetTime.

TimeDiscretizationType oofem::TimeStep::giveTimeDiscretization ( ) [inline]

Returns time discretization.

Definition at line 181 of file timestep.h.

References timeDiscretization.

Referenced by oofem::DIIDynamic::determineConstants(), oofem::NonLinearDynamic::determineConstants(), oofem::DIIDynamic::giveNextStep(), oofem::NonLinearDynamic::giveNextStep(), and oofem::DIIDynamic::solveYourselfAt().

double oofem::TimeStep::giveTimeIncrement ( ) [inline]

Returns solution step associated time increment.

Definition at line 140 of file timestep.h.

References deltaT.

Referenced by oofem::NRSolver::applyConstraintsToLoadIncrement(), oofem::NLTransientTransportProblem::assembleAlgorithmicPartOfRhs(), oofem::KelvinChainSolidMaterial::computeBetaMu(), oofem::MPSMaterial::computeBetaMu(), oofem::TR1_2D_CBS::computeConvectionTermsI(), oofem::TR1_2D_CBS::computeCorrectionRhs(), oofem::TR1_2D_CBS::computeDensityRhsPressureTerms(), oofem::MPSMaterial::computeEquivalentTime(), oofem::B3SolidMaterial::computeFlowTermViscosity(), oofem::MPSMaterial::computeFlowTermViscosity(), oofem::HydratingHeMoMaterial::computeInternalSourceVector(), oofem::HydratingIsoHeatMaterial::computeInternalSourceVector(), oofem::HydrationModel::computeIntSource(), oofem::KelvinChainSolidMaterial::computeLambdaMu(), oofem::MPSMaterial::computeLambdaMu(), oofem::B3SolidMaterial::computeMicroPrestress(), oofem::B3SolidMaterial::computeSolidifiedVolume(), oofem::MPSMaterial::computeSolidifiedVolume(), oofem::Line2SurfaceTension::computeTangent(), oofem::TF1::computeValueAt(), oofem::UserDefinedTemperatureField::computeValueAt(), oofem::DIIDynamic::determineConstants(), oofem::NonLinearDynamic::determineConstants(), oofem::LEPlic::doLagrangianPhase(), oofem::LoadTimeFunction::evaluate(), oofem::TrabBone3D::evaluateCurrentViscousModulus(), oofem::TrabBone3D::evaluateCurrentViscousStress(), oofem::HydratingHeMoMaterial::giveCharacteristicValue(), oofem::HydratingIsoHeatMaterial::giveCharacteristicValue(), oofem::MaxwellChainMaterial::giveEigenStrainVector(), oofem::KelvinChainMaterial::giveEigenStrainVector(), oofem::B3SolidMaterial::giveEigenStrainVector(), oofem::MPSMaterial::giveEigenStrainVector(), oofem::NonStationaryTransportProblem::giveElementCharacteristicMatrix(), oofem::SUPG::giveElementCharacteristicMatrix(), oofem::KelvinChainMaterial::giveEModulus(), oofem::MaxwellChainMaterial::giveEModulus(), oofem::B3SolidMaterial::giveEModulus(), oofem::MPSMaterial::giveEModulus(), oofem::MPSMaterial::giveInitViscosity(), oofem::StokesFlow::giveNextStep(), oofem::AbaqusUserMaterial::giveRealStressVector(), oofem::ConcreteDPM2::giveRealStressVector(), oofem::HellmichMaterial::giveTimeIncrement(), oofem::NLTransientTransportProblem::giveUnknownComponent(), oofem::LevelSetPCS::redistance(), oofem::EngngModel::restoreContext(), oofem::FE2FluidMaterialStatus::setTimeStep(), oofem::NRSolver2::solve(), oofem::NLTransientTransportProblem::solveYourselfAt(), oofem::CBS::solveYourselfAt(), oofem::SUPG::updateDofUnknownsDictionary_corrector(), oofem::SUPG::updateDofUnknownsDictionary_predictor(), oofem::HydratingHeMoMaterial::updateInternalState(), oofem::HydratingIsoHeatMaterial::updateInternalState(), oofem::HydrationModel::updateInternalState(), oofem::HydrationModelInterface::updateInternalState(), oofem::LevelSetPCS::updatePosition(), oofem::SUPG::updateSolutionVectors(), oofem::SUPG::updateSolutionVectors_predictor(), oofem::Tet1_3D_SUPG::updateStabilizationCoeffs(), oofem::TR1_2D_SUPG_AXI::updateStabilizationCoeffs(), oofem::TR1_2D_SUPG2_AXI::updateStabilizationCoeffs(), oofem::TR1_2D_SUPG2::updateStabilizationCoeffs(), oofem::TR1_2D_SUPG::updateStabilizationCoeffs(), oofem::Quad10_2D_SUPG::updateStabilizationCoeffs(), oofem::Concrete2::updateStirrups(), oofem::KelvinChainMaterial::updateYourself(), oofem::MaxwellChainMaterial::updateYourself(), and oofem::Node::updateYourself().

int oofem::TimeStep::giveVersion ( ) [inline]

Returns receiver's version.

Definition at line 125 of file timestep.h.

References version.

Referenced by oofem::NonLinearStatic::proceedStep().

void oofem::TimeStep::incrementStateCounter ( ) [inline]

Updates solution state counter.

Definition at line 177 of file timestep.h.

References solutionStateCounter.

Referenced by oofem::CylindricalALM::do_lineSearch(), oofem::HuertaErrorEstimator::estimateError(), oofem::StructuralEngngModel::giveInternalForces(), oofem::LineSearchNM::solve(), oofem::NRSolver::solve(), oofem::NRSolver2::solve(), oofem::CylindricalALM::solve(), oofem::NLTransientTransportProblem::solveYourselfAt(), oofem::StationaryTransportProblem::solveYourselfAt(), oofem::LinearStatic::solveYourselfAt(), oofem::NonStationaryTransportProblem::solveYourselfAt(), oofem::StaggeredProblem::solveYourselfAt(), oofem::CBS::solveYourselfAt(), oofem::SUPG::solveYourselfAt(), and oofem::NlDEIDynamic::solveYourselfAt().

void oofem::TimeStep::incrementVersion ( ) [inline]

Increments receiver's version.

Definition at line 179 of file timestep.h.

References version.

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

IRResultType oofem::TimeStep::initializeFrom ( InputRecord * ir ) [inline]

Definition at line 183 of file timestep.h.

References oofem::IRRT_OK.

bool oofem::TimeStep::isIcApply ( )

Check if receiver is solution step when initial conditions should apply.

Returns:: True if ic apply, false otherwise.

Definition at line 127 of file timestep.C.

References eModel, oofem::EngngModel::giveNumberOfTimeStepWhenIcApply(), and number.

bool oofem::TimeStep::isNotTheLastStep ( )

Check if solution step is not the last step.

Returns:: True if not last step, false otherwise.

Definition at line 110 of file timestep.C.

References eModel, oofem::EngngModel::giveNumberOfSteps(), and number.

Referenced by oofem::EngngModel::balanceLoad().

bool oofem::TimeStep::isTheCurrentTimeStep ( )

Check if receiver is current solution step.

Returns:: True if receiver is current step, false otherwise.

Definition at line 138 of file timestep.C.

References eModel, and oofem::EngngModel::giveCurrentStep().

Referenced by givePreviousStep(), oofem::Node::giveUpdatedCoordinate(), and oofem::Node::giveUpdatedCoordinates().

bool oofem::TimeStep::isTheFirstStep ( )

Check if receiver is first step.

Returns:: True if receiver is the first step, false otherwise.

Definition at line 117 of file timestep.C.

References eModel, oofem::EngngModel::giveNumberOfFirstStep(), and number.

Referenced by oofem::NRSolver::applyConstraintsToLoadIncrement(), oofem::EngngModel::balanceLoad(), oofem::MPSMaterial::computeEquivalentTime(), oofem::MPSMaterial::computeFlowTermViscosity(), oofem::B3SolidMaterial::computeMicroPrestress(), oofem::TF1::computeValueAt(), oofem::UserDefinedTemperatureField::computeValueAt(), oofem::LoadTimeFunction::evaluate(), oofem::Dof::giveBcValue(), oofem::MPSMaterial::giveEigenStrainVector(), oofem::MPSMaterial::giveEModulus(), oofem::B3Material::giveShrinkageStrainVector(), oofem::B3SolidMaterial::giveShrinkageStrainVector(), oofem::NLTransientTransportProblem::solveYourselfAt(), oofem::IncrementalLinearStatic::solveYourselfAt(), and oofem::NonStationaryTransportProblem::solveYourselfAt().

TimeStep & oofem::TimeStep::operator= ( const TimeStep & src )

Definition at line 80 of file timestep.C.

References deltaT, eModel, intrinsicTime, mstepNumber, number, solutionStateCounter, targetTime, and version.

contextIOResultType oofem::TimeStep::restoreContext	(	DataStream *	stream,
		ContextMode	mode,
		void *	obj = `NULL`
	)

Restores the receiver state previously written in stream.

See also:: saveContext member function.

Definition at line 189 of file timestep.C.

References oofem::CIO_IOERR, oofem::CIO_OK, mstepNumber, number, oofem::DataStream::read(), THROW_CIOERR, and timeDiscretization.

Referenced by oofem::PrimaryField::restoreContext(), and oofem::EngngModel::restoreContext().

contextIOResultType oofem::TimeStep::saveContext	(	DataStream *	stream,
		ContextMode	mode,
		void *	obj = `NULL`
	)

Stores receiver state to output stream.

Receiver should write class-id first in order to allow test whether correct data are then restored.

Parameters:

stream	Output stream.
mode	Determines amount of info required in stream (state, definition,...).
obj	Special parameter, used only to send particular integration. point to material class version of this method. Except this case, obj parameter is always NULL pointer.

Exceptions:

ContextIOERR If error encountered.

Definition at line 146 of file timestep.C.

References oofem::CIO_IOERR, oofem::CIO_OK, mstepNumber, number, THROW_CIOERR, timeDiscretization, and oofem::DataStream::write().

Referenced by oofem::PrimaryField::saveContext().

void oofem::TimeStep::setIntrinsicTime ( double newt ) [inline]

Sets only intrinsic time.

Definition at line 148 of file timestep.h.

References intrinsicTime.

Referenced by oofem::MacroLSpace::computeStiffnessMatrix(), oofem::MacroLSpace::giveInternalForcesVector(), and oofem::NonStationaryTransportProblem::giveNextStep().

void oofem::TimeStep::setNumber ( int i ) [inline]

Set receiver's number.