WxStepperStatus Class Reference

Represents important parameters for the efficacy of a completing simulation step. More...

#include <wxstepperstatus.h>

Detailed Description

Represents important parameters for the efficacy of a completing simulation step.

Public Member Functions
	WxStepperStatus (bool timeStepStatus=true, std::shared_ptr< TimestepConstraint > tc=std::make_shared< TimestepConstraint >())
	Create status object.
void	reset ()
	Returns object to its default construction state.
void	setTimeStepStatus (bool timeStepStatus)
	Set status of stepper's time step (i.e., CFL condition )
bool	getTimeStepStatus () const
	Get status of stepper's time step (i.e., CFL condition )
const std::shared_ptr< TimestepConstraint >	get_tc () const
	Get writeout diagnostic.
void	merge (const WxStepperStatus &other)
	Merge resulting in worst case properties of this and other WxStepperStatus.
void	add_tc (const std::shared_ptr< TimestepConstraint > &tc)
	Add timestep constraint information to wxstepperstatus.

Constructor & Destructor Documentation

WxStepperStatus()

WxStepperStatus::WxStepperStatus ( bool  timeStepStatus = true, std::shared_ptr< TimestepConstraint >  tc = std::make_shared<TimestepConstraint>()  )

inline

Create status object.

Parameters

status	true if status is success
tc	timestep constraint

Member Function Documentation

add_tc()

void WxStepperStatus::add_tc ( const std::shared_ptr< TimestepConstraint > &  tc )

inline

Add timestep constraint information to wxstepperstatus.

Parameters

tc	timestep constraint

get_tc()

const std::shared_ptr< TimestepConstraint > WxStepperStatus::get_tc ( ) const

inline

Get writeout diagnostic.

Returns

writeout diagnostic

getTimeStepStatus()

bool WxStepperStatus::getTimeStepStatus ( ) const

inline

Get status of stepper's time step (i.e., CFL condition )

Returns

status of stepper's time step, true if successfull

merge()

void WxStepperStatus::merge ( const WxStepperStatus &  other )

inline

Merge resulting in worst case properties of this and other WxStepperStatus.

Parameters

other

WxStepperStatus

reset()

void WxStepperStatus::reset ( )

inline

Returns object to its default construction state.

Maximum suggested time step and no errors.

setTimeStepStatus()

void WxStepperStatus::setTimeStepStatus ( bool  timeStepStatus )

inline

Set status of stepper's time step (i.e., CFL condition )

Parameters

timeStepStatus

Status of stepper's time step, true if successfull

---

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

• src/solver/wxstepperstatus.h