chombo-discharge
Public Member Functions | Protected Attributes | List of all members
Physics::BrownianWalker::BrownianWalkerTagger Class Reference

Implementation of CellTagger for tagging cells for Brownian walker physics. More...

#include <CD_BrownianWalkerTagger.H>

Inheritance diagram for Physics::BrownianWalker::BrownianWalkerTagger:
Inheritance graph
[legend]
Collaboration diagram for Physics::BrownianWalker::BrownianWalkerTagger:
Collaboration graph
[legend]

Public Member Functions

 BrownianWalkerTagger ()=delete
 Disallowed weak construction – use the full constructor.
 
 BrownianWalkerTagger (RefCountedPtr< ItoSolver > &a_solver, RefCountedPtr< AmrMesh > &a_amr)
 Full constructor. More...
 
 ~BrownianWalkerTagger ()
 Destructor (does nothing)
 
void regrid () override
 Regrid method (does nothing)
 
void parseOptions () override
 Parse options.
 
bool tagCells (EBAMRTags &a_tags) override
 Tag cells (does nothing, returns false) More...
 
- Public Member Functions inherited from CellTagger
 CellTagger ()
 Weak constructor (does nothing)
 
virtual ~CellTagger ()
 Destructor (does nothing).
 
virtual void preRegrid () noexcept
 Pre-regrid function for cell-tagger.
 
virtual void parseRuntimeOptions ()
 Parse runtime class options. More...
 
virtual void prePlot () const noexcept
 Perform pre-plotting operations (if necessary)
 
virtual int getNumberOfPlotVariables () const
 Get number of plot variables that will be written to file (by Driver). More...
 
virtual Vector< std::string > getPlotVariableNames () const
 Get plot variable names.
 
virtual void writePlotData (LevelData< EBCellFAB > &a_output, int &a_icomp, const std::string a_outputRealm, const int a_level) const
 Write plot data. More...
 
virtual int getBuffer () const
 Get tag buffer. More...
 

Protected Attributes

RefCountedPtr< ItoSolverm_solver
 Reference to solver.
 
RefCountedPtr< AmrMeshm_amr
 Reference to AmrMesh.
 
Real m_refMagn
 Magnitude refinement threshold (not currently used)
 
- Protected Attributes inherited from CellTagger
std::string m_name
 Cell tagger class name (default is CellTagger).
 
int m_verbosity
 Class verbosity.
 
int m_buffer
 Tag buffer. Grow tags by this amount (finest level only)
 
Vector< RealBoxm_tagBoxes
 Boxes that can be used to restrict tagging.
 
std::vector< std::pair< RealBox, int > > m_refBoxes
 Refinement boxes for adding manual refinement.
 

Additional Inherited Members

- Protected Member Functions inherited from CellTagger
bool insideTagBox (const RealVect a_pos) const
 Check if a point is inside a tagging box. More...
 
int getManualRefinementLevel (const RealVect a_pos) const
 Get the specified level for this position when doing manual refinement.
 
virtual void parseTagBoxes ()
 Parse boxes. More...
 
virtual void parseRefinementBoxes ()
 Parse refinement boxes.
 
virtual void parseBuffer ()
 Parse refinement buffer. More...
 
virtual void parseVerbosity ()
 Parse the verbosity from the input file or command line. More...
 

Detailed Description

Implementation of CellTagger for tagging cells for Brownian walker physics.

This class just implements the interface but does not flag any cells for refinement. However, it returns true from the tagging routine so that TimeStepper and Driver can load balance the application.

Constructor & Destructor Documentation

◆ BrownianWalkerTagger()

BrownianWalkerTagger::BrownianWalkerTagger ( RefCountedPtr< ItoSolver > &  a_solver,
RefCountedPtr< AmrMesh > &  a_amr 
)

Full constructor.

Parameters
[in]a_solverSolver to be tracked
[in]a_amrReference to AmrMesh – needed because we need access to the grids.

Member Function Documentation

◆ tagCells()

bool BrownianWalkerTagger::tagCells ( EBAMRTags a_tags)
overridevirtual

Tag cells (does nothing, returns false)

Parameters
[in,out]a_tagsCell tags

Implements CellTagger.


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