Lightweight tagging class. Only tags cells based on the electric field. More...

#include <CD_ItoKMCFieldTagger.H>

Inheritance diagram for Physics::ItoKMC::ItoKMCFieldTagger< S >:

[legend]

Collaboration diagram for Physics::ItoKMC::ItoKMCFieldTagger< S >:

[legend]

Public Member Functions
	ItoKMCFieldTagger () noexcept
	Weak constructor. User MUST subsequently call define.

virtual	~ItoKMCFieldTagger () noexcept
	Destructor.

virtual void	computeTagFields () const noexcept override
	Compute tagging fields.

virtual void	parseOptions () override=0
	Parse options.

virtual void	parseRuntimeOptions () override=0
	Parse run-time configurable options.

Public Member Functions inherited from Physics::ItoKMC::ItoKMCTagger< S >
	ItoKMCTagger ()
	Weak constructor. User MUST subsequently call the define function.

	ItoKMCTagger (const RefCountedPtr< ItoKMCPhysics > &a_physics, const RefCountedPtr< S > &a_timeStepper, const RefCountedPtr< AmrMesh > &a_amr) noexcept
	Full constructor.

virtual	~ItoKMCTagger () noexcept
	Destructor.

virtual void	define (const RefCountedPtr< ItoKMCPhysics > &a_physics, const RefCountedPtr< S > &a_timeStepper, const RefCountedPtr< AmrMesh > &a_amr) noexcept
	Define function.

virtual int	getNumberOfPlotVariables () const noexcept override
	Get number of plot variables that will be written to file (by Driver).

virtual Vector< std::string >	getPlotVariableNames () const noexcept override
	Get plot variable names.

virtual void	writePlotData (LevelData< EBCellFAB > &a_output, int &a_icomp, const std::string &a_outputRealm, const int a_level) const noexcept override
	Write plot data.

virtual void	regrid () noexcept override
	Regrid this class. Note that there is no preRegrid method.

virtual bool	tagCells (EBAMRTags &a_tags) noexcept override
	Tag cells for refinement and coarsening.

virtual void	setPhase (const phase::which_phase a_phase) noexcept
	Set the phase where we do the tagging.

virtual Vector< EBAMRCellData > &	getTagFields () noexcept
	Get the tagging fields (mutable reference).

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	prePlot () const noexcept
	Perform pre-plotting operations (if necessary)

virtual int	getBuffer () const
	Get tag buffer.

Protected Member Functions
virtual void	allocateStorage () const noexcept
	Allocate memory for scratch, electric field, and gradient of electric field.

virtual void	deallocateStorage () const noexcept
	Deallocate memory.

virtual void	computeElectricField (EBAMRCellData &a_E, EBAMRCellData &a_gradE) const noexcept
	Compute the electric field and its gradient magnitude.

virtual Vector< Real >	computeTagFields (const RealVect &a_pos, const Real a_time, const Real a_dx, const RealVect &a_E, const Real a_minE, const Real a_maxE, const RealVect &a_gradE, const Real a_minGradE, const Real a_maxGradE) const noexcept=0
	Compute per-cell tagging field values from the electric field and its gradient.

virtual bool	coarsenCell (const RealVect &a_pos, const Real a_time, const Real a_dx, const int a_lvl, const Vector< Real > &a_tagFields, const Vector< RealVect > &a_gradTagFields) const noexcept override=0
	Determine if a particular cell should be coarsened or not.

virtual bool	refineCell (const RealVect &a_pos, const Real a_time, const Real a_dx, const int a_lvl, const Vector< Real > &a_tagFields, const Vector< RealVect > &a_gradTagFields) const noexcept override=0
	Determine if a particular cell should be refined or not.

Protected Member Functions inherited from Physics::ItoKMC::ItoKMCTagger< S >
virtual void	tagCellsBox (DenseIntVectSet &a_refinedCells, DenseIntVectSet &a_coarsenedCells, const Vector< EBCellFAB * > &a_tagFields, const Vector< EBCellFAB * > &a_gradTagFields, const int a_lvl, const DataIndex a_dit, const Box a_box, const EBISBox &a_ebisbox, const Real a_time, const Real a_dx, const RealVect a_probLo) const noexcept
	Per-box refinement tagging routine.

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.

Protected Attributes
EBAMRCellData	m_scratch
	Scratch storage.

EBAMRCellData	m_E
	Storage for the electric field E.

EBAMRCellData	m_gradE
	Storage for grad(\|E\|)

Protected Attributes inherited from Physics::ItoKMC::ItoKMCTagger< S >
bool	m_isDefined
	Defined or not.

bool	m_plotData
	Plot data or not.

std::string	m_realm
	Realm where data is allocated.

phase::which_phase	m_phase
	Phase where data is allocated.

RefCountedPtr< ItoKMCPhysics >	m_physics
	Physics implementation.

RefCountedPtr< S >	m_timeStepper
	Time stepper.

RefCountedPtr< AmrMesh >	m_amr
	AmrMesh. Needed for allocating memory and things like that.

int	m_numTagFields
	Number of tagging fields.

Vector< EBAMRCellData >	m_tagFields
	Tagging fields.

Vector< EBAMRCellData >	m_gradTagFields
	Gradient of tagging fields.

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.

Detailed Description

template<typename S>
class Physics::ItoKMC::ItoKMCFieldTagger< S >

Lightweight tagging class. Only tags cells based on the electric field.

This class fetches the point-wise electric field. The class is pure, so users must still implement the actual tagging criterion themselves. However, this class at the very least exposes the per-cell refinement/coarsening in terms of the electric field only.

Member Function Documentation

◆ coarsenCell()

template<typename S >

virtual bool Physics::ItoKMC::ItoKMCFieldTagger< S >::coarsenCell	(	const RealVect &	a_pos,
		const Real	a_time,
		const Real	a_dx,
		const int	a_lvl,
		const Vector< Real > &	a_tagFields,
		const Vector< RealVect > &	a_gradTagFields
	)		const

overrideprotectedpure virtualnoexcept

Determine if a particular cell should be coarsened or not.

Parameters

[in]	a_pos	Physical position.
[in]	a_time	Current time
[in]	a_dx	Grid resolution
[in]	a_lvl	Grid level
[in]	a_tagFields	Cell tagging fields
[in]	a_gradTagFields	Gradient of cell tagging fields

Returns: Return value

Implements Physics::ItoKMC::ItoKMCTagger< S >.

Implemented in Physics::ItoKMC::ItoKMCStreamerTagger< S >.

◆ computeElectricField()

template<typename S >

void ItoKMCFieldTagger::computeElectricField	(	EBAMRCellData &	a_E,
		EBAMRCellData &	a_gradE
	)		const

protectedvirtualnoexcept

Compute the electric field and its gradient magnitude.

Parameters

[out]	a_E	Cell-centred electric field vector.
[out]	a_gradE	Cell-centred gradient of \|E\|.

◆ computeTagFields() [1/2]

template<typename S >

void ItoKMCFieldTagger::computeTagFields ( ) const

overridevirtualnoexcept

Compute tagging fields.

Implements Physics::ItoKMC::ItoKMCTagger< S >.

◆ computeTagFields() [2/2]

template<typename S >

virtual Vector< Real > Physics::ItoKMC::ItoKMCFieldTagger< S >::computeTagFields	(	const RealVect &	a_pos,
		const Real	a_time,
		const Real	a_dx,
		const RealVect &	a_E,
		const Real	a_minE,
		const Real	a_maxE,
		const RealVect &	a_gradE,
		const Real	a_minGradE,
		const Real	a_maxGradE
	)		const

protectedpure virtualnoexcept

Compute per-cell tagging field values from the electric field and its gradient.

Parameters

[in]	a_pos	Physical coordinates.
[in]	a_time	Current simulation time.
[in]	a_dx	Grid resolution.
[in]	a_E	Electric field vector at this cell.
[in]	a_minE	Minimum \|E\| over the domain.
[in]	a_maxE	Maximum \|E\| over the domain.
[in]	a_gradE	grad(\|E\|) at this cell.
[in]	a_minGradE	Minimum \|grad(\|E\|)\| over the domain.
[in]	a_maxGradE	Maximum \|grad(\|E\|)\| over the domain.

Returns: Per-cell tagging field values.

Implemented in Physics::ItoKMC::ItoKMCStreamerTagger< S >.

◆ parseOptions()

template<typename S >

virtual void Physics::ItoKMC::ItoKMCFieldTagger< S >::parseOptions ( )

overridepure virtual

Parse options.

Implements Physics::ItoKMC::ItoKMCTagger< S >.

Implemented in Physics::ItoKMC::ItoKMCStreamerTagger< S >.

◆ parseRuntimeOptions()

template<typename S >

virtual void Physics::ItoKMC::ItoKMCFieldTagger< S >::parseRuntimeOptions ( )

overridepure virtual

Parse run-time configurable options.

Implements Physics::ItoKMC::ItoKMCTagger< S >.

Implemented in Physics::ItoKMC::ItoKMCStreamerTagger< S >.

◆ refineCell()

template<typename S >

virtual bool Physics::ItoKMC::ItoKMCFieldTagger< S >::refineCell	(	const RealVect &	a_pos,
		const Real	a_time,
		const Real	a_dx,
		const int	a_lvl,
		const Vector< Real > &	a_tagFields,
		const Vector< RealVect > &	a_gradTagFields
	)		const

overrideprotectedpure virtualnoexcept

Determine if a particular cell should be refined or not.

Parameters

[in]	a_pos	Physical position.
[in]	a_time	Current time
[in]	a_dx	Grid resolution
[in]	a_lvl	Grid level
[in]	a_tagFields	Cell tagging fields
[in]	a_gradTagFields	Gradient of cell tagging fields

Returns: Return value

Implements Physics::ItoKMC::ItoKMCTagger< S >.

Implemented in Physics::ItoKMC::ItoKMCStreamerTagger< S >.

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

Physics/ItoKMC/CD_ItoKMCFieldTagger.H
Physics/ItoKMC/CD_ItoKMCFieldTaggerImplem.H

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ coarsenCell()

◆ computeElectricField()

◆ computeTagFields() [1/2]

◆ computeTagFields() [2/2]

◆ parseOptions()

◆ parseRuntimeOptions()

◆ refineCell()