amrex::PlotFileData Class Reference

#include <AMReX_PlotFileUtil.H>

Public Member Functions
	PlotFileData (std::string const &plotfile_name)
int	spaceDim () const noexcept
Real	time () const noexcept
int	finestLevel () const noexcept
int	refRatio (int level) const
IntVect	refRatioVect (int level) const
	Return the per-direction refinement ratio vector for the requested level.
int	levelStep (int level) const
const BoxArray &	boxArray (int level) const
const DistributionMapping &	DistributionMap (int level) const
void	syncDistributionMap (PlotFileData const &src)
void	syncDistributionMap (int level, PlotFileData const &src)
int	coordSys () const noexcept
Box	probDomain (int level) const
Array< Real, 3 >	probSize () const noexcept
Array< Real, 3 >	probLo () const noexcept
Array< Real, 3 >	probHi () const noexcept
Array< Real, 3 >	cellSize (int level) const
const Vector< std::string > &	varNames () const noexcept
int	nComp () const noexcept
IntVect	nGrowVect (int level) const
MultiFab	get (int level)
MultiFab	get (int level, std::string const &varname)

Detailed Description

helper class for reading plotfile

Constructor & Destructor Documentation

PlotFileData()

amrex::PlotFileData::PlotFileData ( std::string const &  plotfile_name )

inline

Member Function Documentation

boxArray()

const BoxArray & amrex::PlotFileData::boxArray ( int  level ) const

inline

cellSize()

Array< Real, 3 > amrex::PlotFileData::cellSize ( int  level ) const

inline

coordSys()

int amrex::PlotFileData::coordSys ( ) const

inlinenoexcept

DistributionMap()

const DistributionMapping & amrex::PlotFileData::DistributionMap ( int  level ) const

inline

finestLevel()

int amrex::PlotFileData::finestLevel ( ) const

inlinenoexcept

get() [1/2]

MultiFab amrex::PlotFileData::get ( int  level )

inline

get() [2/2]

MultiFab amrex::PlotFileData::get ( int  level, std::string const &  varname  )

inline

levelStep()

int amrex::PlotFileData::levelStep ( int  level ) const

inline

nComp()

int amrex::PlotFileData::nComp ( ) const

inlinenoexcept

nGrowVect()

IntVect amrex::PlotFileData::nGrowVect ( int  level ) const

inline

probDomain()

Box amrex::PlotFileData::probDomain ( int  level ) const

inline

probHi()

Array< Real, 3 > amrex::PlotFileData::probHi ( ) const

inlinenoexcept

probLo()

Array< Real, 3 > amrex::PlotFileData::probLo ( ) const

inlinenoexcept

probSize()

Array< Real, 3 > amrex::PlotFileData::probSize ( ) const

inlinenoexcept

refRatio()

int amrex::PlotFileData::refRatio ( int  level ) const

inline

Note that the refinement ratio stored in plotfiles are integers, not IntVects, for backward compatibility. If you have non-uniform refinement ratio, you could compute it by using probDomain(int level).

refRatioVect()

IntVect amrex::PlotFileData::refRatioVect ( int  level ) const

inline

Return the per-direction refinement ratio vector for the requested level.

spaceDim()

int amrex::PlotFileData::spaceDim ( ) const

inlinenoexcept

syncDistributionMap() [1/2]

void amrex::PlotFileData::syncDistributionMap ( int  level, PlotFileData const &  src  )

inline

syncDistributionMap() [2/2]

void amrex::PlotFileData::syncDistributionMap ( PlotFileData const &  src )

inline

time()

Real amrex::PlotFileData::time ( ) const

inlinenoexcept

varNames()

const Vector< std::string > & amrex::PlotFileData::varNames ( ) const

inlinenoexcept

---

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

• /home/runner/work/amrex/amrex/Src/Base/AMReX_PlotFileUtil.H