REMORA
Regional Modeling of Oceans Refined Adaptively
Loading...
Searching...
No Matches
Public Member Functions | Private Attributes | List of all members
ParticleData Class Reference

#include <REMORA_ParticleData.H>

Collaboration diagram for ParticleData:
Collaboration graph
[legend]

Public Member Functions

 ParticleData ()
 
 ~ParticleData ()
 
void Checkpoint (const std::string &a_fname) const
 
void writePlotFile (const std::string &a_fname, const amrex::Vector< amrex::MultiFab > &a_xy) const
 
void Restart (amrex::ParGDBBase *a_gdb, const std::string &a_fname)
 
void GetMeshPlotVarNames (amrex::Vector< std::string > &a_names) const
 
void GetMeshPlotVar (const std::string &a_var_name, amrex::MultiFab &a_mf, const int a_lev)
 
void Redistribute ()
 
REMORAPC * GetSpecies (const std::string &a_name)
 
REMORAPC * operator[] (const std::string &a_name)
 
const REMORAPC * GetSpecies (const std::string &a_name) const
 
const REMORAPC * operator[] (const std::string &a_name) const
 
void pushBack (const std::string &a_name, REMORAPC *const a_pc)
 
void addName (const std::string &a_name)
 
const ParticlesNamesVector & getNames () const
 
ParticlesNamesList & getNamesUnalloc ()
 
bool contains (const std::string &a_name) const
 
bool isEmpty () const
 

Private Attributes

ParticleSpeciesMap m_particle_species
 
ParticlesNamesVector m_namelist
 
ParticlesNamesList m_namelist_unalloc
 

Detailed Description

Definition at line 27 of file REMORA_ParticleData.H.

Constructor & Destructor Documentation

◆ ParticleData()

ParticleData::ParticleData ( )
inline

Constructor

Definition at line 32 of file REMORA_ParticleData.H.

Here is the call graph for this function:

◆ ~ParticleData()

ParticleData::~ParticleData ( )
inline

Destructor

Definition at line 41 of file REMORA_ParticleData.H.

Here is the call graph for this function:

Member Function Documentation

◆ addName()

void ParticleData::addName ( const std::string &  a_name)
inline

Add a name; particle container will be initialized later

Definition at line 205 of file REMORA_ParticleData.H.

Referenced by REMORA::readTracersParams().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ Checkpoint()

void ParticleData::Checkpoint ( const std::string &  a_fname) const
inline

Write checkpoint files

Definition at line 54 of file REMORA_ParticleData.H.

Referenced by REMORA::WriteCheckpointFile().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ contains()

bool ParticleData::contains ( const std::string &  a_name) const
inline

queries if container has species of a certain name

Definition at line 226 of file REMORA_ParticleData.H.

Referenced by pushBack().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ GetMeshPlotVar()

void ParticleData::GetMeshPlotVar ( const std::string &  a_var_name,
amrex::MultiFab &  a_mf,
const int  a_lev 
)
inline

Definition at line 106 of file REMORA_ParticleData.H.

Referenced by REMORA::WritePlotFile().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ GetMeshPlotVarNames()

void ParticleData::GetMeshPlotVarNames ( amrex::Vector< std::string > &  a_names) const
inline

Get mesh plot quantities from each particle container

Definition at line 91 of file REMORA_ParticleData.H.

Referenced by REMORA::append2DPlotVariables(), REMORA::append3DPlotVariables(), and REMORA::WritePlotFile().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ getNames()

const ParticlesNamesVector & ParticleData::getNames ( ) const
inline

Returns list of names of particle species

Definition at line 212 of file REMORA_ParticleData.H.

Referenced by REMORA::ErrorEst(), and REMORA::WritePlotFile().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ getNamesUnalloc()

ParticlesNamesList & ParticleData::getNamesUnalloc ( )
inline

Returns list of names of particle species that are unallocated

Definition at line 219 of file REMORA_ParticleData.H.

Referenced by REMORA::initializeTracers(), and REMORA::set3DPlotVariables().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ GetSpecies() [1/2]

REMORAPC * ParticleData::GetSpecies ( const std::string &  a_name)
inline

Get species of a given name

Definition at line 139 of file REMORA_ParticleData.H.

Here is the call graph for this function:

◆ GetSpecies() [2/2]

const REMORAPC * ParticleData::GetSpecies ( const std::string &  a_name) const
inline

Get species of a given name (const version)

Definition at line 167 of file REMORA_ParticleData.H.

Here is the call graph for this function:

◆ isEmpty()

bool ParticleData::isEmpty ( ) const
inline

query if container is empty

Definition at line 234 of file REMORA_ParticleData.H.

Referenced by Restart(), and REMORA::WritePlotFile().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ operator[]() [1/2]

REMORAPC * ParticleData::operator[] ( const std::string &  a_name)
inline

accessor

Definition at line 153 of file REMORA_ParticleData.H.

Here is the call graph for this function:

◆ operator[]() [2/2]

const REMORAPC * ParticleData::operator[] ( const std::string &  a_name) const
inline

accessor

Definition at line 181 of file REMORA_ParticleData.H.

Here is the call graph for this function:

◆ pushBack()

void ParticleData::pushBack ( const std::string &  a_name,
REMORAPC *const  a_pc 
)
inline

Add a particle species to this container

Definition at line 195 of file REMORA_ParticleData.H.

Referenced by REMORA::initializeTracers(), and Restart().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ Redistribute()

void ParticleData::Redistribute ( )
inline

Redistribute/rebalance particles data

Definition at line 130 of file REMORA_ParticleData.H.

Referenced by REMORA::MakeNewLevelFromScratch(), REMORA::post_timestep(), REMORA::RemakeLevel(), and REMORA::timeStep().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ Restart()

void ParticleData::Restart ( amrex::ParGDBBase *  a_gdb,
const std::string &  a_fname 
)
inline

Read from restart file

Definition at line 77 of file REMORA_ParticleData.H.

Referenced by REMORA::ReadCheckpointFile().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ writePlotFile()

void ParticleData::writePlotFile ( const std::string &  a_fname,
const amrex::Vector< amrex::MultiFab > &  a_xy 
) const
inline

Write particles to a plotfile, with x and y in physical coordinates

Definition at line 65 of file REMORA_ParticleData.H.

Referenced by REMORA::WritePlotFile().

Here is the call graph for this function:
Here is the caller graph for this function:

Member Data Documentation

◆ m_namelist

ParticlesNamesVector ParticleData::m_namelist
private

Vector of particle species names

Definition at line 246 of file REMORA_ParticleData.H.

Referenced by Checkpoint(), GetMeshPlotVar(), GetMeshPlotVarNames(), getNames(), ParticleData(), pushBack(), Redistribute(), writePlotFile(), and ~ParticleData().

◆ m_namelist_unalloc

ParticlesNamesList ParticleData::m_namelist_unalloc
private

List with names of unallocated species

Definition at line 248 of file REMORA_ParticleData.H.

Referenced by addName(), getNamesUnalloc(), ParticleData(), Restart(), and ~ParticleData().

◆ m_particle_species

ParticleSpeciesMap ParticleData::m_particle_species
private

Vector of all particle species

Definition at line 244 of file REMORA_ParticleData.H.

Referenced by Checkpoint(), contains(), GetMeshPlotVar(), GetMeshPlotVarNames(), GetSpecies(), GetSpecies(), isEmpty(), operator[](), operator[](), ParticleData(), pushBack(), Redistribute(), writePlotFile(), and ~ParticleData().

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