amrex::InSituBridge Class Reference

A base class for coupling to the SENSEI in situ library. More...

#include <AMReX_InSituBridge.H>

Inheritance diagram for amrex::InSituBridge:

Public Member Functions
	InSituBridge ()
virtual	~InSituBridge ()
	InSituBridge (const InSituBridge &)=delete
void	operator= (const InSituBridge &)=delete
virtual int	initialize ()
virtual int	finalize ()
	clean up the adaptors More...
Runtime Control Parameters
These may set explicitly or via ParmParse. ParmParse values take precedence over set calls. parameter description sensei.enabled integer 0 or 1, when 0 the bridge is disabled sensei.frequency integer >= 1, how often the analysis executes sensei.config file path, path to the SENSEI XML config sensei.pin_mesh integer, 0 or 1, when 1 mesh origin is forced to 0,0,0
void	setEnabled (int aenabled)
void	setFrequency (int freq)
void	setConfig (const std::string &aconfig)
void	setPinMesh (int apinMesh)

Protected Member Functions
bool	doUpdate ()

Protected Attributes
std::string	config
int	enabled
int	frequency
int	counter
int	pinMesh

Detailed Description

A base class for coupling to the SENSEI in situ library.

Implements initialize and finalize. Derived classes implement an update method. See AmrInSituBridge and AmrMeshInSituBridge.

Constructor & Destructor Documentation

InSituBridge() [1/2]

amrex::InSituBridge::InSituBridge

(

)

~InSituBridge()

amrex::InSituBridge::~InSituBridge ( )

virtual

InSituBridge() [2/2]

amrex::InSituBridge::InSituBridge ( const InSituBridge &  )

delete

Member Function Documentation

doUpdate()

bool amrex::InSituBridge::doUpdate ( )

protected

finalize()

int amrex::InSituBridge::finalize ( )

virtual

clean up the adaptors

initialize()

int amrex::InSituBridge::initialize ( )

virtual

initialize the adaptors. Will make use of ParmParse for any unset control parameters.

operator=()

void amrex::InSituBridge::operator= ( const InSituBridge &  )

delete

setConfig()

void amrex::InSituBridge::setConfig ( const std::string &  aconfig )

inline

setEnabled()

void amrex::InSituBridge::setEnabled ( int  aenabled )

inline

setFrequency()

void amrex::InSituBridge::setFrequency ( int  freq )

inline

setPinMesh()

void amrex::InSituBridge::setPinMesh ( int  apinMesh )

inline

Member Data Documentation

config

std::string amrex::InSituBridge::config

protected

counter

int amrex::InSituBridge::counter

protected

enabled

int amrex::InSituBridge::enabled

protected

frequency

int amrex::InSituBridge::frequency

protected

pinMesh

int amrex::InSituBridge::pinMesh

protected

---

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

• /home/runner/work/amrex/amrex/Src/Extern/SENSEI/AMReX_InSituBridge.H
• /home/runner/work/amrex/amrex/Src/Extern/SENSEI/AMReX_InSituBridge.cpp