Block-Structured AMR Software Framework
amrex::VisMF::Header Struct Reference

An on-disk FabArray<FArrayBox> contains this info in a header file. More...

#include <AMReX_VisMF.H>

Public Types

enum  Version {
  Undefined_v1 = 0 , Version_v1 = 1 , NoFabHeader_v1 = 2 , NoFabHeaderMinMax_v1 = 3 ,
  NoFabHeaderFAMinMax_v1 = 4
}
 The versions of the FabArray<FArrayBox> Header code. More...
 

Public Member Functions

 Header ()
 The default constructor. More...
 
 Header (const FabArray< FArrayBox > &mf, VisMF::How how, Version version=Version_v1, bool calcMinMax=true, MPI_Comm=ParallelDescriptor::Communicator())
 Construct from a FabArray<FArrayBox>. More...
 
 ~Header ()=default
 
 Header (Header &&rhs) noexcept=default
 
 Header (Header const &)=delete
 
Headeroperator= (Header const &)=delete
 
Headeroperator= (Header &&)=delete
 
void CalculateMinMax (const FabArray< FArrayBox > &mf, int procToWrite=ParallelDescriptor::IOProcessorNumber(), MPI_Comm=ParallelDescriptor::Communicator())
 Calculate the min and max arrays. More...
 

Public Attributes

int m_vers {VisMF::Header::Undefined_v1}
 The version of the Header. More...
 
How m_how
 How the MF was written to disk. More...
 
int m_ncomp
 Number of components in MF. More...
 
IntVect m_ngrow
 The number of ghost cells in MF. More...
 
BoxArray m_ba
 The BoxArray of the MF. More...
 
Vector< FabOnDiskm_fod
 FabOnDisk info for contained FABs. More...
 
Vector< Vector< Real > > m_min
 The min()s of each component of FABs. [findex][comp]. More...
 
Vector< Vector< Real > > m_max
 The max()s of each component of FABs. [findex][comp]. More...
 
Vector< Real > m_famin
 The min()s of each component of the FabArray. [comp]. More...
 
Vector< Real > m_famax
 The max()s of each component of the FabArray. [comp]. More...
 
RealDescriptor m_writtenRD
 

Detailed Description

An on-disk FabArray<FArrayBox> contains this info in a header file.

Member Enumeration Documentation

◆ Version

The versions of the FabArray<FArrayBox> Header code.

Enumerator
Undefined_v1 

-— undefined

Version_v1 

-— auto converting version with headers -— for each fab in the data files and -— min and max values for each fab in the header

NoFabHeader_v1 

-— no fab headers, no fab mins or maxes

NoFabHeaderMinMax_v1 

-— no fab headers, -— min and max values for each fab in the header

NoFabHeaderFAMinMax_v1 

-— no fab headers, no fab mins or maxes, -— min and max values for each FabArray in the header

Constructor & Destructor Documentation

◆ Header() [1/4]

amrex::VisMF::Header::Header ( )
default

The default constructor.

◆ Header() [2/4]

amrex::VisMF::Header::Header ( const FabArray< FArrayBox > &  mf,
VisMF::How  how,
Version  version = Version_v1,
bool  calcMinMax = true,
MPI_Comm  comm = ParallelDescriptor::Communicator() 
)

Construct from a FabArray<FArrayBox>.

◆ ~Header()

amrex::VisMF::Header::~Header ( )
default

◆ Header() [3/4]

amrex::VisMF::Header::Header ( Header &&  rhs)
defaultnoexcept

◆ Header() [4/4]

amrex::VisMF::Header::Header ( Header const &  )
delete

Member Function Documentation

◆ CalculateMinMax()

void amrex::VisMF::Header::CalculateMinMax ( const FabArray< FArrayBox > &  mf,
int  procToWrite = ParallelDescriptor::IOProcessorNumber(),
MPI_Comm  comm = ParallelDescriptor::Communicator() 
)

Calculate the min and max arrays.

◆ operator=() [1/2]

Header& amrex::VisMF::Header::operator= ( Header &&  )
delete

◆ operator=() [2/2]

Header& amrex::VisMF::Header::operator= ( Header const &  )
delete

Member Data Documentation

◆ m_ba

BoxArray amrex::VisMF::Header::m_ba

The BoxArray of the MF.

◆ m_famax

Vector<Real> amrex::VisMF::Header::m_famax

The max()s of each component of the FabArray. [comp].

◆ m_famin

Vector<Real> amrex::VisMF::Header::m_famin

The min()s of each component of the FabArray. [comp].

◆ m_fod

Vector< FabOnDisk > amrex::VisMF::Header::m_fod

FabOnDisk info for contained FABs.

◆ m_how

How amrex::VisMF::Header::m_how

How the MF was written to disk.

◆ m_max

Vector< Vector<Real> > amrex::VisMF::Header::m_max

The max()s of each component of FABs. [findex][comp].

◆ m_min

Vector< Vector<Real> > amrex::VisMF::Header::m_min

The min()s of each component of FABs. [findex][comp].

◆ m_ncomp

int amrex::VisMF::Header::m_ncomp

Number of components in MF.

◆ m_ngrow

IntVect amrex::VisMF::Header::m_ngrow

The number of ghost cells in MF.

◆ m_vers

int amrex::VisMF::Header::m_vers {VisMF::Header::Undefined_v1}

The version of the Header.

◆ m_writtenRD

RealDescriptor amrex::VisMF::Header::m_writtenRD

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