SPHinXsys  alpha version
Public Member Functions | List of all members
SPH::StateEngine::AddedStateVariable Class Reference

Class for handling state variable added (allocated) by this StateEngine. More...

#include <state_engine.h>

Inherits SPH::StateEngine::StateVariable.

Public Member Functions

 AddedStateVariable ()
 
 AddedStateVariable (std::string &name, StateEngine &owner, SimTK::Stage invalidatestage)
 
Real getValue () override
 
void setValue (Real value) override
 
Real getDerivative () override
 
void setDerivative (Real deriv) override
 
- Public Member Functions inherited from SPH::StateEngine::StateVariable
 StateVariable ()
 
 StateVariable (std::string &name, StateEngine &owner, SimTK::SubsystemIndex subsys, int varindex)
 
std::string & getName ()
 
StateEnginegetOwner ()
 
int & getVarIndex ()
 
SimTK::SubsystemIndex & getSubsysIndex ()
 
SimTK::SystemYIndex & getSystemYIndex ()
 
void setVarIndex (int index)
 
void setSubsystemIndex (SimTK::SubsystemIndex &subsysindx)
 

Detailed Description

Class for handling state variable added (allocated) by this StateEngine.

Constructor & Destructor Documentation

◆ AddedStateVariable() [1/2]

SPH::StateEngine::AddedStateVariable::AddedStateVariable ( )
inline

Constructors adn destrucutors.

◆ AddedStateVariable() [2/2]

SPH::StateEngine::AddedStateVariable::AddedStateVariable ( std::string &  name,
StateEngine owner,
SimTK::Stage  invalidatestage 
)
inlineexplicit

Convenience constructor for defining a StateEngine added state variable < stage this variable invalidates.

Parameters
namestate var name.

Member Function Documentation

◆ getValue()

Real SPH::StateEngine::AddedStateVariable::getValue ( )
overridevirtual

override virtual methods.

Implements SPH::StateEngine::StateVariable.

◆ setDerivative()

void SPH::StateEngine::AddedStateVariable::setDerivative ( Real  deriv)
overridevirtual

The derivative a state should be a cache entry and thus does not change the state.

Implements SPH::StateEngine::StateVariable.


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