PlasCom2  1.0
XPACC Multi-physics simluation application
Public Types | Public Member Functions | Public Attributes | Protected Attributes | List of all members
base< DomainType > Class Template Reference

Detailed Description

template<typename DomainType>
class simulation::advancer::base< DomainType >

Definition at line 15 of file Advancer.H.

#include <Advancer.H>

Public Types

typedef DomainType::GridType GridType
 
typedef DomainType::StateType StateType
 

Public Member Functions

 base ()
 
 base (DomainType &inDomain)
 
virtual int Configure (fixtures::ConfigurationType &inConfig)
 
virtual int InitializeAdvance ()
 
virtual int InitializeAdvancer (DomainType &inDomain, std::ostream &messageStream)
 
virtual int AdvanceDomain ()
 
virtual int FinalizeAdvance ()
 
virtual int InterGridExchange ()
 
virtual void SetError (const std::string &errorMessage, fixtures::CommunicatorType &inComm)
 
virtual int ErrorCheck (fixtures::CommunicatorType &inComm)
 
virtual void SetMessageStream (std::ostream &messageStream)
 

Public Attributes

bool errCheck
 

Protected Attributes

fixtures::ConfigurationType advancerConfig
 
DomainType * domainPtr
 
std::ostream * messageStreamPtr
 
Inheritance diagram for base< DomainType >:
[legend]
Collaboration diagram for base< DomainType >:
[legend]

Member Typedef Documentation

◆ GridType

typedef DomainType::GridType GridType

Definition at line 19 of file Advancer.H.

◆ StateType

typedef DomainType::StateType StateType

Definition at line 20 of file Advancer.H.

Constructor & Destructor Documentation

◆ base() [1/2]

base ( )
inline

Definition at line 24 of file Advancer.H.

◆ base() [2/2]

base ( DomainType &  inDomain)
inline

Definition at line 27 of file Advancer.H.

Member Function Documentation

◆ AdvanceDomain()

virtual int AdvanceDomain ( )
inlinevirtual

Reimplemented in rk4advancer< DomainType >.

Definition at line 43 of file Advancer.H.

Referenced by application< DomainBaseT >::AdvanceDomains().

Here is the caller graph for this function:

◆ Configure()

virtual int Configure ( fixtures::ConfigurationType &  inConfig)
inlinevirtual

Reimplemented in rk4advancer< DomainType >.

Definition at line 33 of file Advancer.H.

◆ ErrorCheck()

virtual int ErrorCheck ( fixtures::CommunicatorType &  inComm)
inlinevirtual

Reimplemented in rk4advancer< DomainType >.

Definition at line 57 of file Advancer.H.

References CommunicatorObject::Check().

Here is the call graph for this function:

◆ FinalizeAdvance()

virtual int FinalizeAdvance ( )
inlinevirtual

Reimplemented in rk4advancer< DomainType >.

Definition at line 47 of file Advancer.H.

Referenced by application< DomainBaseT >::FinalizeStep().

Here is the caller graph for this function:

◆ InitializeAdvance()

virtual int InitializeAdvance ( )
inlinevirtual

Reimplemented in rk4advancer< DomainType >.

Definition at line 35 of file Advancer.H.

Referenced by application< DomainBaseT >::InitializeStep().

Here is the caller graph for this function:

◆ InitializeAdvancer()

virtual int InitializeAdvancer ( DomainType &  inDomain,
std::ostream &  messageStream 
)
inlinevirtual

Definition at line 37 of file Advancer.H.

◆ InterGridExchange()

virtual int InterGridExchange ( )
inlinevirtual

Reimplemented in rk4advancer< DomainType >.

Definition at line 49 of file Advancer.H.

◆ SetError()

virtual void SetError ( const std::string &  errorMessage,
fixtures::CommunicatorType &  inComm 
)
inlinevirtual

Reimplemented in rk4advancer< DomainType >.

Definition at line 51 of file Advancer.H.

References CommunicatorObject::SetErr().

Here is the call graph for this function:

◆ SetMessageStream()

virtual void SetMessageStream ( std::ostream &  messageStream)
inlinevirtual

Reimplemented in rk4advancer< DomainType >.

Definition at line 64 of file Advancer.H.

Member Data Documentation

◆ advancerConfig

fixtures::ConfigurationType advancerConfig
protected

Definition at line 65 of file Advancer.H.

◆ domainPtr

DomainType* domainPtr
protected

Definition at line 70 of file Advancer.H.

◆ errCheck

bool errCheck

Definition at line 22 of file Advancer.H.

◆ messageStreamPtr

std::ostream* messageStreamPtr
protected

Definition at line 71 of file Advancer.H.

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