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

The WmTimedSwapVariables class swaps two like variables, internalized storage remains, while outer shell naming is swapped. More...

#include <wmtimedswapvariables.h>

Inheritance diagram for WmTimedSwapVariables:
WmHostAction WxStepper WxObject

Detailed Description

The WmTimedSwapVariables class swaps two like variables, internalized storage remains, while outer shell naming is swapped.

Public Member Functions

 WmTimedSwapVariables (const WmConstOpaquePtr &parent_solver)
 Create new WmTimedSwapVariables host action.
 
void setup (const WxCryptSet &wxc)
 Setup HostAction object using supplied cryptset.
 
virtual void typeCheck ()
 check that variable types are appropriate for this HostAction.
 
WxStepperStatus step ()
 Step the solver by assigned time step.
 
bool needsDomain () const
 Return false because swap operation does not depend on domain specifics.
 
- Public Member Functions inherited from WmHostAction
 ~WmHostAction () override
 Destroy hostaction.
 
void setup (const WxCryptSet &wxc) override
 Setup hostaction object using supplied cryptset.
 
std::vector< std::string > readVarNames () const
 Get names of all read variables used.
 
std::vector< std::string > writeVarNames () const
 Get names of all write variables used.
 
unsigned numExpectedReadVars () const
 Return number of read variables expected by this hostaction, or minimum number required for hostactions allowing variable number of read vars.
 
unsigned numExpectedWriteVars () const
 Return number of write variables expected by this hostaction, or minimum number required for hostactions allowing variable number of write vars.
 
bool allowsVariableReadVars () const
 Does this hostaction allow variable number of read variables?
 
bool allowsVariableWriteVars () const
 Does this hostaction allow variable number of write variables?
 
virtual bool needsDomain () const
 Return true if this updater needs a domain to work on.
 
void setParentStepHandler (WmExecutionStep< WmHostAction > *parentStepHandler)
 Set enclosing step handler TODO: convert this to being a friend function or something.
 
unsigned numActualReadVars () const
 Get number of actual read variables used when user calls this hostaction.
 
unsigned numActualWriteVars () const
 Get number of actual write variables used when user calls this hostaction.
 
const WmDomaingetDomain () const
 Get (unstructured) domain on which host action works.
 
std::vector< std::string > getWriteVarList () const
 Returns list of write variables for this hostaction.
 
std::vector< std::string > getReadVarList () const
 Returns list of read variables for this hostaction.
 
const WmSolverBasegetParent () const
 Get parent solver object.
 
- Public Member Functions inherited from WxStepper
 WxStepper ()
 Create a new stepper.
 
virtual ~WxStepper ()
 Dtor: destroy object.
 
void setDt (time_t dt)
 Set time-step for the step method.
 
time_t getDt () const
 Get time-step for the step method.
 
void setTimeData (const WxStepper &timeData)
 Set time data for the step method.
 
void setCurrentTime (time_t tcurr)
 Set current time.
 
time_t incrementCurrentTime (time_t tadd)
 Increment current time.
 
time_t getCurrentTime () const
 Get the current time.
 
void setCurrentFrame (int frame)
 Set current frame number.
 
int incrementCurrentFrame ()
 Increment current frame number.
 
int getCurrentFrame () const
 Get the current frame number.
 
virtual WxStepperStatus step ()=0
 Advance the stepper by assigned time step.
 
virtual WxStepperStatus end ()
 Perform actions only done at simulation end.
 
- 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.
 

Protected Attributes

real _previous_time
 
real _swap_time
 
- Protected Attributes inherited from WmHostAction
bool _allReadVarsSameType
 
bool _allWriteVarsSameType
 
bool _allowsVariableReadVars
 
bool _allowsVariableWriteVars
 
bool _WriteVarConditionHasBeenSet
 
bool _ReadVarConditionHasBeenSet
 
unsigned _numExpectedReadVars
 
unsigned _numExpectedWriteVars
 

Additional Inherited Members

- Public Types inherited from WxStepper
typedef real time_t
 Time scalar data type.
 
- Protected Member Functions inherited from WmHostAction
 WmHostAction (const WmConstOpaquePtr &parent_solver)
 Create new hostaction.
 
const std::type_info & getVarType (const std::string &variableName) const
 Get a variable types from the parent solver.
 
const wxm::variable::variable_tgetReadVar (unsigned pos) const
 Get a reference to a read variable.
 
wxm::variable::variable_tgetWriteVar (unsigned pos) const
 Get a reference to a write variable.
 
virtual void typeCheck ()=0
 Check that the provided variables meet the expected variable types for this hostaction.
 
- 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.
 

Constructor & Destructor Documentation

◆ WmTimedSwapVariables()

WmTimedSwapVariables::WmTimedSwapVariables ( const WmConstOpaquePtr parent_solver)
inline

Create new WmTimedSwapVariables host action.

Parameters
parent_solvertype opaque wrapper to parent solver

Member Function Documentation

◆ needsDomain()

bool WmTimedSwapVariables::needsDomain ( ) const
inlinevirtual

Return false because swap operation does not depend on domain specifics.

Returns
false

Reimplemented from WmHostAction.

◆ setup()

void WmTimedSwapVariables::setup ( const WxCryptSet wxc)
virtual

Setup HostAction object using supplied cryptset.

Parameters
wxcCryptset to use for setting

Reimplemented from WmHostAction.

◆ step()

WxStepperStatus WmTimedSwapVariables::step ( )
virtual

Step the solver by assigned time step.

Returns
return status of step

Implements WxStepper.

◆ typeCheck()

virtual void WmTimedSwapVariables::typeCheck ( )
virtual

check that variable types are appropriate for this HostAction.

Implements WmHostAction.

Member Data Documentation

◆ _previous_time

real WmTimedSwapVariables::_previous_time
protected

◆ _swap_time

real WmTimedSwapVariables::_swap_time
protected

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