Rythmos - Transient Integration for Differential Equations Version of the Day
Public Member Functions | Public Attributes | Related Functions
Rythmos::StepControlInfo< Scalar > Struct Template Reference

Simple struct to aggregate integration/stepper control information. More...

#include <Rythmos_StepControlInfo.hpp>

List of all members.

Public Member Functions

 StepControlInfo ()
 Initialize to invalid state.

Public Attributes

Scalar stepSize
 The size of the time step.
StepSizeType stepType
 The type of time step.
bool limitedByBreakPoint
 True if step size is limited by a breakpoint.
EBreakPointType breakPointType
 True if the time integrator should restart when passing over the breakpoint.

Related Functions

(Note that these are not member functions.)

template<class Scalar >
StepControlInfo< Scalar > stepCtrlInfoTaken (const StepControlInfo< Scalar > &trialStepCtrlInfo, const Scalar &stepSizeTaken)
 Return a step control info object for a step actually taken.

Detailed Description

template<class Scalar>
struct Rythmos::StepControlInfo< Scalar >

Simple struct to aggregate integration/stepper control information.

Definition at line 18 of file Rythmos_StepControlInfo.hpp.


Constructor & Destructor Documentation

template<class Scalar>
Rythmos::StepControlInfo< Scalar >::StepControlInfo ( ) [inline]

Initialize to invalid state.

Definition at line 29 of file Rythmos_StepControlInfo.hpp.


Friends And Related Function Documentation

template<class Scalar >
StepControlInfo< Scalar > stepCtrlInfoTaken ( const StepControlInfo< Scalar > &  trialStepCtrlInfo,
const Scalar &  stepSizeTaken 
) [related]

Return a step control info object for a step actually taken.

All integrator subclass implementations should use this function to update the step control info for a step actually taken.

Definition at line 62 of file Rythmos_StepControlInfo.hpp.


Member Data Documentation

template<class Scalar>
Scalar Rythmos::StepControlInfo< Scalar >::stepSize

The size of the time step.

Definition at line 20 of file Rythmos_StepControlInfo.hpp.

template<class Scalar>
StepSizeType Rythmos::StepControlInfo< Scalar >::stepType

The type of time step.

Definition at line 22 of file Rythmos_StepControlInfo.hpp.

template<class Scalar>
bool Rythmos::StepControlInfo< Scalar >::limitedByBreakPoint

True if step size is limited by a breakpoint.

Definition at line 24 of file Rythmos_StepControlInfo.hpp.

template<class Scalar>
EBreakPointType Rythmos::StepControlInfo< Scalar >::breakPointType

True if the time integrator should restart when passing over the breakpoint.

Definition at line 27 of file Rythmos_StepControlInfo.hpp.


The documentation for this struct was generated from the following file:
 All Classes Functions Variables Typedefs Friends