WARPXM v1.10.0
Loading...
Searching...
No Matches
WmHostSequencedGroup Class Reference

Sequenced group that contains serial set of host steps generally implemented as host (C++) code. More...

#include <wmhostsequencedgroup.h>

Inheritance diagram for WmHostSequencedGroup:
WmSequencedGroup WxObject

Detailed Description

Sequenced group that contains serial set of host steps generally implemented as host (C++) code.

Public Member Functions

 WmHostSequencedGroup (const WmConstOpaquePtr &parent_solver)
 Create new WmHostSequencedGroup.
 
virtual void setup (const WxCryptSet &wxc)
 Setup the hostsequencedgroup using cryptset.
 
- Public Member Functions inherited from WmSequencedGroup
virtual void setup (const WxCryptSet &wxc)
 Setup the sequencedgroup using cryptset.
 
SequenceActionItr begin () const
 
SequenceActionItr end () const
 
const WmSolverBasegetParent () const
 Get parent solver object.
 
- Public Member Functions inherited from WxObject
virtual ~WxObject ()
 Dtor: destroy object.
 
void setIo (WxIoBase &io)
 Set the I/O pointer for use in object.
 
void setMsg (WxMsgBase &msg)
 Set the msg pointer for use in object.
 
WxIoBasegetIo ()
 Return reference to I/O object.
 
const WxIoBasegetIo () const
 Return constant reference to I/O object.
 
WxMsgBasegetMsg ()
 Return reference to msg object.
 
const WxMsgBasegetMsg () const
 Return const reference to msg object.
 
virtual void setup (const WxCryptSet &wxc)
 Setup object using supplied crypset.
 
virtual void init ()
 Initialize the object.
 
virtual void finishBuild ()
 Finish building the object.
 
virtual void load (WxIoBase &io, const WxIoNodeType &grpNode)
 Load object from file.
 
virtual void dump (WxIoBase &io, WxIoNodeType &grpNode) const
 Dump object to file.
 
virtual std::string name () const
 Get name of object.
 
void setName (const std::string &nm)
 Set object's name.
 

Additional Inherited Members

- Public Types inherited from WmSequencedGroup
typedef std::vector< std::string >::const_iterator SequenceActionItr
 Iterator support funcions to access host actions.
 
- Public Attributes inherited from WmSequencedGroup
real dtFrac
 Fraction of time-step to apply.
 
- Protected Member Functions inherited from WmSequencedGroup
 WmSequencedGroup (const WmConstOpaquePtr &parent_solver)
 Create new WmSequencedGroup.
 
- Protected Member Functions inherited from WxObject
 WxObject ()
 Create object, that will be initialized subsequently.
 
 WxObject (const std::string &name)
 Create object with given name bypassing object setup phase Protected because there is no reason to have a WxObject directly, as it is meant to be a parent class.
 
- Protected Attributes inherited from WmSequencedGroup
std::vector< std::string > hostActions
 host actions to apply
 

Constructor & Destructor Documentation

◆ WmHostSequencedGroup()

WmHostSequencedGroup::WmHostSequencedGroup ( const WmConstOpaquePtr parent_solver)
inline

Create new WmHostSequencedGroup.

Parameters
parent_solvertype opaque wrapper to parent solver

Member Function Documentation

◆ setup()

virtual void WmHostSequencedGroup::setup ( const WxCryptSet wxc)
virtual

Setup the hostsequencedgroup using cryptset.

Parameters
wxcCryptset using which the object is set up.

Reimplemented from WmSequencedGroup.


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