FlushFormatCatalyst Class Reference

This class aims at dumping performing in-situ analysis and visualization with Catalyst. Catalyst initialize and finalize are called in the constructor and destructor respectivelyThe function WriteToFile takes in the particles, meshes, and fields, and formats them to be used by given pipeline scripts. All exports are defined and executed externally through the given catalyst pipeline and implementation. More...

#include <FlushFormatCatalyst.H>

Inheritance diagram for FlushFormatCatalyst:

Public Member Functions
	FlushFormatCatalyst ()
void	WriteToFile (const amrex::Vector< std::string > &varnames, const amrex::Vector< amrex::MultiFab > &mf, amrex::Vector< amrex::Geometry > &geom, amrex::Vector< int > iteration, double time, const amrex::Vector< ParticleDiag > &particle_diags, int nlev, std::string prefix, int file_min_digits, bool plot_raw_fields, bool plot_raw_fields_guards, int verbose=2, bool use_pinned_pc=false, bool isBTD=false, int snapshotID=-1, int bufferID=1, int numBuffers=1, const amrex::Geometry &full_BTD_snapshot=amrex::Geometry(), bool isLastBTDFlush=false) const override
	~FlushFormatCatalyst () override=default
	FlushFormatCatalyst (FlushFormatCatalyst const &)=default
FlushFormatCatalyst &	operator= (FlushFormatCatalyst const &)=default
	FlushFormatCatalyst (FlushFormatCatalyst &&)=default
FlushFormatCatalyst &	operator= (FlushFormatCatalyst &&)=default
Public Member Functions inherited from FlushFormatInSitu
	FlushFormatInSitu ()=default
	~FlushFormatInSitu () override=default
	FlushFormatInSitu (FlushFormatInSitu const &)=default
FlushFormatInSitu &	operator= (FlushFormatInSitu const &)=default
	FlushFormatInSitu (FlushFormatInSitu &&)=default
FlushFormatInSitu &	operator= (FlushFormatInSitu &&)=default
Public Member Functions inherited from FlushFormat
	FlushFormat ()=default
virtual	~FlushFormat ()=default
	FlushFormat (FlushFormat const &)=default
FlushFormat &	operator= (FlushFormat const &)=default
	FlushFormat (FlushFormat &&)=default
FlushFormat &	operator= (FlushFormat &&)=default

Detailed Description

This class aims at dumping performing in-situ analysis and visualization with Catalyst. Catalyst initialize and finalize are called in the constructor and destructor respectivelyThe function WriteToFile takes in the particles, meshes, and fields, and formats them to be used by given pipeline scripts. All exports are defined and executed externally through the given catalyst pipeline and implementation.

Constructor & Destructor Documentation

FlushFormatCatalyst() [1/3]

FlushFormatCatalyst::FlushFormatCatalyst

(

)

~FlushFormatCatalyst()

FlushFormatCatalyst::~FlushFormatCatalyst ( )

overridedefault

FlushFormatCatalyst() [2/3]

FlushFormatCatalyst::FlushFormatCatalyst ( FlushFormatCatalyst const & )

default

FlushFormatCatalyst() [3/3]

FlushFormatCatalyst::FlushFormatCatalyst ( FlushFormatCatalyst && )

default

Member Function Documentation

operator=() [1/2]

FlushFormatCatalyst & FlushFormatCatalyst::operator= ( FlushFormatCatalyst && )

default

operator=() [2/2]

FlushFormatCatalyst & FlushFormatCatalyst::operator= ( FlushFormatCatalyst const & )

default

WriteToFile()

void FlushFormatCatalyst::WriteToFile ( const amrex::Vector< std::string > & varnames, const amrex::Vector< amrex::MultiFab > & mf, amrex::Vector< amrex::Geometry > & geom, amrex::Vector< int > iteration, double time, const amrex::Vector< ParticleDiag > & particle_diags, int nlev, std::string prefix, int file_min_digits, bool plot_raw_fields, bool plot_raw_fields_guards, int verbose = 2, bool use_pinned_pc = false, bool isBTD = false, int snapshotID = -1, int bufferID = 1, int numBuffers = 1, const amrex::Geometry & full_BTD_snapshot = amrex::Geometry(), bool isLastBTDFlush = false ) const

overridevirtual

Send particle, mesh, and field information through the catalyst pipeline

Implements FlushFormat.

---

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

• /home/docs/checkouts/readthedocs.org/user_builds/warpx/checkouts/6102/Source/Diagnostics/FlushFormats/FlushFormatCatalyst.H
• /home/docs/checkouts/readthedocs.org/user_builds/warpx/checkouts/6102/Source/Diagnostics/FlushFormats/FlushFormatCatalyst.cpp