VPTissue Reference Manual
SimPT_Sim::CoupledSim Class Reference

Coupled Simulator: multiple simulators and couplers. More...

#include <CoupledSim.h>

Inheritance diagram for SimPT_Sim::CoupledSim:
Inheritance graph
Collaboration diagram for SimPT_Sim::CoupledSim:
Collaboration graph

Public Member Functions

 CoupledSim ()
 Constructor does almost no initialization work (. More...
 
virtual ~CoupledSim ()
 Destructor is virtual.
 
CoreDataGetCoreData () override final
 
const boost::property_tree::ptree & GetParameters () const
 
std::string GetProjectName () const
 
std::string GetRunDate () const
 
int GetSimStep () const
 
Timings GetTimings () const
 
void IncrementStepCount ()
 Increase the current time step counter by one.
 
void Initialize (const boost::property_tree::ptree &pt, const std::vector< std::shared_ptr< Sim >> &simulators)
 Initialize with full configuration (complete setup prior to first use).
 
bool IsAtTermination () const
 
bool IsStationary () const
 
void Reinitialize (const boost::property_tree::ptree &parameters)
 
void TimeStep ()
 
- Public Member Functions inherited from SimPT_Sim::SimInterface
virtual ~SimInterface ()
 Virtual destructor.
 
- Public Member Functions inherited from SimPT_Sim::ClockMan::Timeable<>
virtual ~Timeable ()
 Destructor virtual for polymorphic class.
 
- Public Member Functions inherited from SimPT_Sim::Util::Subject< SimPT_Sim::Event::CoupledSimEvent, std::weak_ptr< const void > >
void Notify (const EventType &)
 
void Register (const U *, CallbackType)
 
void Unregister (const U *)
 
void UnregisterAll ()
 

Additional Inherited Members

- Public Types inherited from SimPT_Sim::ClockMan::Timeable<>
using Timings = typename ClockTraits< std::chrono::system_clock, typename std::chrono::system_clock::duration >::CumulativeTimings
 
- Public Types inherited from SimPT_Sim::ClockMan::ClockTraits< std::chrono::system_clock, typename std::chrono::system_clock::duration >
using Clock = std::chrono::system_clock
 Type for clock.
 
using CumulativeTimings = SimPT_Sim::ClockMan::CumulativeRecords< typename std::chrono::system_clock::duration >
 Records with cumulative timing info.
 
using Duration = typename std::chrono::system_clock::duration
 Type for time duration units.
 
using IndividualTimings = SimPT_Sim::ClockMan::IndividualRecords< typename std::chrono::system_clock::duration >
 Records with individual timing info.
 
using Stopclock = SimPT_Sim::ClockMan::Stopwatch< std::chrono::system_clock >
 Stopwatch to measure time durations.
 
- Public Types inherited from SimPT_Sim::Util::Subject< SimPT_Sim::Event::CoupledSimEvent, std::weak_ptr< const void > >
typedef std::function< void(const EventType &)> CallbackType
 
typedef SimPT_Sim::Event::CoupledSimEvent EventType
 
typedef const std::weak_ptr< const void > * KeyType
 

Detailed Description

Coupled Simulator: multiple simulators and couplers.

Definition at line 42 of file CoupledSim.h.

Constructor & Destructor Documentation

SimPT_Sim::CoupledSim::CoupledSim ( )

Constructor does almost no initialization work (.

See also
CoupledSim::Initialize)

Definition at line 39 of file CoupledSim.cpp.

Member Function Documentation

CoreData& SimPT_Sim::CoupledSim::GetCoreData ( )
inlinefinaloverridevirtual
See also
SimInterface.

Implements SimPT_Sim::SimInterface.

Definition at line 54 of file CoupledSim.h.

const ptree & SimPT_Sim::CoupledSim::GetParameters ( ) const
virtual
See also
SimInterface.

Implements SimPT_Sim::SimInterface.

Definition at line 44 of file CoupledSim.cpp.

string SimPT_Sim::CoupledSim::GetProjectName ( ) const
virtual
See also
SimInterface.

Implements SimPT_Sim::SimInterface.

Definition at line 49 of file CoupledSim.cpp.

string SimPT_Sim::CoupledSim::GetRunDate ( ) const
virtual
See also
SimInterface.

Implements SimPT_Sim::SimInterface.

Definition at line 54 of file CoupledSim.cpp.

int SimPT_Sim::CoupledSim::GetSimStep ( ) const
virtual
See also
SimInterface.

Implements SimPT_Sim::SimInterface.

Definition at line 59 of file CoupledSim.cpp.

CoupledSim::Timings SimPT_Sim::CoupledSim::GetTimings ( ) const
virtual
See also
SimInterface.

Implements SimPT_Sim::SimInterface.

Definition at line 64 of file CoupledSim.cpp.

bool SimPT_Sim::CoupledSim::IsAtTermination ( ) const
virtual
See also
SimInterface.

Implements SimPT_Sim::SimInterface.

Definition at line 92 of file CoupledSim.cpp.

bool SimPT_Sim::CoupledSim::IsStationary ( ) const
virtual
See also
SimInterface.

Implements SimPT_Sim::SimInterface.

Definition at line 102 of file CoupledSim.cpp.

void SimPT_Sim::CoupledSim::Reinitialize ( const boost::property_tree::ptree &  parameters)
virtual
See also
SimInterface.

Implements SimPT_Sim::SimInterface.

Definition at line 112 of file CoupledSim.cpp.

References SimPT_Sim::Util::FunctionMap< S >::Get(), and SimPT_Sim::Util::FunctionMap< S >::IsValid().

Referenced by Initialize().

Here is the call graph for this function:

Here is the caller graph for this function:

void SimPT_Sim::CoupledSim::TimeStep ( )
virtual
See also
SimInterface.

Implements SimPT_Sim::SimInterface.

Definition at line 141 of file CoupledSim.cpp.

References SimPT_Sim::ClockMan::Stopwatch< T >::Get(), SimPT_Sim::ClockMan::Stopwatch< T >::GetName(), and IncrementStepCount().

Here is the call graph for this function:


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