Physics::BrownianWalker::BrownianWalkerTagger Class Reference

CellTagger implementation for the Brownian walker physics module. More...

#include <CD_BrownianWalkerTagger.H>

Inheritance diagram for Physics::BrownianWalker::BrownianWalkerTagger:

Collaboration diagram for Physics::BrownianWalker::BrownianWalkerTagger:

Public Member Functions
	BrownianWalkerTagger ()=delete
	Disallowed default constructor.
	BrownianWalkerTagger (RefCountedPtr< ItoSolver > &a_solver, RefCountedPtr< AmrMesh > &a_amr)
	Full constructor.
	~BrownianWalkerTagger ()
	Destructor.
void	regrid () override
	Regrid hook. No operations are performed.
void	parseOptions () override
	Parse tagging options from ParmParse. Reads m_refMagn.
bool	tagCells (EBAMRTags &a_tags) override
	Tag cells for refinement. Currently tags no cells but returns true to trigger load balancing.
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.
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).
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.
virtual int	getBuffer () const
	Get tag buffer.

Protected Attributes
RefCountedPtr< ItoSolver >	m_solver
	Ito solver reference, available for future tagging criteria.
RefCountedPtr< AmrMesh >	m_amr
	AMR mesh reference.
Real	m_refMagn
	Magnitude refinement threshold (reserved for future use).
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< RealBox >	m_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.
int	getManualRefinementLevel (const RealVect &a_pos) const
	Get the specified level for this position when doing manual refinement.
virtual void	parseTagBoxes ()
	Parse boxes.
virtual void	parseRefinementBoxes ()
	Parse refinement boxes.
virtual void	parseBuffer ()
	Parse refinement buffer.
virtual void	parseVerbosity ()
	Parse the verbosity from the input file or command line.

Detailed Description

CellTagger implementation for the Brownian walker physics module.

This tagger does not flag any cells for refinement, but always returns true from tagCells so that Driver can trigger load balancing at each regrid step.

Constructor & Destructor Documentation

BrownianWalkerTagger()

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

Full constructor.

Parameters

[in]	a_solver	Ito solver whose particle data may inform future tagging extensions.
[in]	a_amr	AMR mesh providing grid access.

Member Function Documentation

parseOptions()

void BrownianWalkerTagger::parseOptions ( )

overridevirtual

Parse tagging options from ParmParse. Reads m_refMagn.

Implements CellTagger.

regrid()

void BrownianWalkerTagger::regrid ( )

overridevirtual

Regrid hook. No operations are performed.

Implements CellTagger.

tagCells()

bool BrownianWalkerTagger::tagCells ( EBAMRTags &  a_tags )

overridevirtual

Tag cells for refinement. Currently tags no cells but returns true to trigger load balancing.

Parameters

[in,out]

a_tags

Cell tags across the AMR hierarchy.

Returns

Always true.

Implements CellTagger.

---

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

• Physics/BrownianWalker/CD_BrownianWalkerTagger.H
• Physics/BrownianWalker/CD_BrownianWalkerTagger.cpp