FlushFormatSensei Class Reference

This class aims at dumping performing in-situ diagnostics with SENSEI. In particular, function WriteToFile takes fields and particles as input arguments, and calls amrex functions to do the in-situ visualization. More...

#include <FlushFormatSensei.H>

Inheritance diagram for FlushFormatSensei:

Public Member Functions
	FlushFormatSensei ()
	~FlushFormatSensei ()
	FlushFormatSensei (const FlushFormatSensei &)=delete
void	operator= (const FlushFormatSensei &)=delete
	FlushFormatSensei (amrex::AmrMesh *amr_mesh, std::string diag_name)
virtual void	WriteToFile (const amrex::Vector< std::string > varnames, const amrex::Vector< amrex::MultiFab > &mf, amrex::Vector< amrex::Geometry > &geom, const amrex::Vector< int > iteration, const double time, const amrex::Vector< ParticleDiag > &particle_diags, int nlev, const std::string prefix, int file_min_digits, bool plot_raw_fields, bool plot_raw_fields_guards, const 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 amrex::Vector< int > &totalParticlesFlushedAlready=amrex::Vector< int >()) const override
void	WriteParticles (const amrex::Vector< ParticleDiag > &particle_diags) const
	Do in-situ visualization for particle data. More...
Public Member Functions inherited from FlushFormat
virtual	~FlushFormat ()

Private Attributes
std::string	m_insitu_config
int	m_insitu_pin_mesh = 0
amrex::AmrMeshParticleInSituBridge *	m_insitu_bridge = nullptr
amrex::AmrMesh *	m_amr_mesh = nullptr

Detailed Description

This class aims at dumping performing in-situ diagnostics with SENSEI. In particular, function WriteToFile takes fields and particles as input arguments, and calls amrex functions to do the in-situ visualization.

To use the SENSEI flush format one must compile WarpX with the GNUMakefile setting: USE_SENSEI_INSITU=TRUE

In addition to the standard controls, the following inputs file fields are supported:

 sensei_config - the path to a SENSEI XML configuration (required)
 sensei_pin_mesh - integer 0 or 1 forcing the moving mesh to be fixed
                   at 0,0,0 (optional)

Fri 29 May 2020 11:19:38 AM PDT : Tested with SENSEI version 3.2.0

Constructor & Destructor Documentation

FlushFormatSensei() [1/3]

FlushFormatSensei::FlushFormatSensei

(

)

~FlushFormatSensei()

FlushFormatSensei::~FlushFormatSensei

(

)

FlushFormatSensei() [2/3]

FlushFormatSensei::FlushFormatSensei ( const FlushFormatSensei &  )

delete

FlushFormatSensei() [3/3]

FlushFormatSensei::FlushFormatSensei	(	amrex::AmrMesh *	amr_mesh,
		std::string	diag_name
	)

Construct.

Parameters

[in]	amr_mesh	an AmrMesh instance
[in]	diag_name	ParmParse scope string.

Member Function Documentation

operator=()

void FlushFormatSensei::operator= ( const FlushFormatSensei &  )

delete

WriteParticles()

void FlushFormatSensei::WriteParticles

(

const amrex::Vector< ParticleDiag > &

particle_diags

)

const

Do in-situ visualization for particle data.

Parameters

[in]

particle_diags

Each element of this vector handles output of 1 species.

WriteToFile()

void FlushFormatSensei::WriteToFile ( const amrex::Vector< std::string >  varnames, const amrex::Vector< amrex::MultiFab > &  mf, amrex::Vector< amrex::Geometry > &  geom, const amrex::Vector< int >  iteration, const double  time, const amrex::Vector< ParticleDiag > &  particle_diags, int  nlev, const std::string  prefix, int  file_min_digits, bool  plot_raw_fields, bool  plot_raw_fields_guards, const 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 amrex::Vector< int > &  totalParticlesFlushedAlready = amrex::Vector<int>()  ) const

overridevirtual

Do in-situ visualization for field and particle data

Implements FlushFormat.

Member Data Documentation

m_amr_mesh

amrex::AmrMesh* FlushFormatSensei::m_amr_mesh = nullptr

private

m_insitu_bridge

amrex::AmrMeshParticleInSituBridge* FlushFormatSensei::m_insitu_bridge = nullptr

private

m_insitu_config

std::string FlushFormatSensei::m_insitu_config

private

m_insitu_pin_mesh

int FlushFormatSensei::m_insitu_pin_mesh = 0

private

---

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

• /home/docs/checkouts/readthedocs.org/user_builds/artemis-em/checkouts/latest/Source/Diagnostics/FlushFormats/FlushFormatSensei.H
• /home/docs/checkouts/readthedocs.org/user_builds/artemis-em/checkouts/latest/Source/Diagnostics/FlushFormats/FlushFormatSensei.cpp