Class which implements CdrPlasmaFieldTagger and refines cells based on the criterion alpha*dx > threshold or on the curvature of the electric field. More...

#include <CD_CdrPlasmaStreamerTagger.H>

Inheritance diagram for Physics::CdrPlasma::CdrPlasmaStreamerTagger:

[legend]

Collaboration diagram for Physics::CdrPlasma::CdrPlasmaStreamerTagger:

[legend]

Public Member Functions
	CdrPlasmaStreamerTagger ()=delete
	Disallowed weak constructor.

	CdrPlasmaStreamerTagger (const RefCountedPtr< CdrPlasmaPhysics > &a_physics, const RefCountedPtr< CdrPlasmaStepper > &a_timeStepper, const RefCountedPtr< AmrMesh > &a_amr, const RefCountedPtr< ComputationalGeometry > &a_computationalGeometry)
	Full constructor.

virtual	~CdrPlasmaStreamerTagger ()
	Destructor.

virtual void	parseOptions () override
	Parse class options.

virtual void	parseRuntimeOptions () override
	Parse runtime options.

virtual Vector< Real >	tracer (const RealVect a_pos, const Real a_time, const Real a_dx, const RealVect a_electricField, const Real a_minElectricField, const Real a_maxElectricField, const RealVect a_gradElectricField, const Real a_minGradElectricField, const Real a_maxGradElectricField) const override
	Compute tracer fields.

virtual bool	coarsenCell (const RealVect a_pos, const Real a_time, const Real a_dx, const int a_lvl, const Vector< Real > a_tracers, const Vector< RealVect > a_gradTracers) const override
	Cell-coarsening method.

virtual bool	refineCell (const RealVect a_pos, const Real a_time, const Real a_dx, const int a_lvl, const Vector< Real > a_tracers, const Vector< RealVect > a_gradTracers) const override
	Cell-refinement method.

Public Member Functions inherited from Physics::CdrPlasma::CdrPlasmaFieldTagger
	CdrPlasmaFieldTagger ()
	Weak constructor, must subsequently call define.

virtual	~CdrPlasmaFieldTagger ()
	Destructor.

void	computeTracers () const override final
	Compute tracer fields.

Public Member Functions inherited from Physics::CdrPlasma::CdrPlasmaTagger
	CdrPlasmaTagger ()
	Weak constructor. Must subsequently call define.

	CdrPlasmaTagger (const RefCountedPtr< CdrPlasmaPhysics > &a_physics, const RefCountedPtr< CdrPlasmaStepper > &a_timeStepper, const RefCountedPtr< AmrMesh > &a_amr, const RefCountedPtr< ComputationalGeometry > &a_computationalGeometry)
	Full constructor. Leaves object in usable state.

virtual	~CdrPlasmaTagger ()
	Destructor.

void	define (const RefCountedPtr< CdrPlasmaPhysics > &a_physics, const RefCountedPtr< CdrPlasmaStepper > &a_timeStepper, const RefCountedPtr< AmrMesh > &a_amr, const RefCountedPtr< ComputationalGeometry > &a_computationalGeometry)
	Define function constructor. Leaves object in usable state.

virtual void	prePlot () const noexcept override
	Pre-plot magic for Driver.

virtual void	preRegrid () noexcept override
	Perform pre-regrid operations.

virtual void	regrid () override final
	Regrid method – used for reallocating storage for the tracer fields.

virtual bool	tagCells (EBAMRTags &a_tags) override final
	Tag cells for refinement.

virtual int	getNumberOfPlotVariables () const override final
	Get number of plot variables. This is fetched by Driver and can be used.

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

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

Public Member Functions inherited from CellTagger
	CellTagger ()
	Weak constructor (does nothing)

virtual	~CellTagger ()
	Destructor (does nothing).

virtual int	getBuffer () const
	Get tag buffer.

Protected Attributes
Real	m_coarCurv
	Threshold for coarsening based on curvature.

Real	m_refiCurv
	Threshold for refinement based on curvature.

Real	m_refiAlpha
	Threshold for refinement based on Townsend ionization coefficient.

Real	m_coarAlpha
	Threshold for refinement based on Townsend ionization coefficient.

int	m_maxCoarsenLevel
	Set coarsening level.

Protected Attributes inherited from Physics::CdrPlasma::CdrPlasmaFieldTagger
EBAMRCellData	m_scratch
	Scratch storage.

EBAMRCellData	m_electricField
	Storage for electric field.

EBAMRCellData	m_gradElectricField
	Storage for electric field.

Protected Attributes inherited from Physics::CdrPlasma::CdrPlasmaTagger
std::string	m_realm
	Realm where this cell tagger allocates its data.

phase::which_phase	m_phase
	Phase where this cell tagger allocates its data.

RefCountedPtr< CdrPlasmaPhysics >	m_physics
	Plasma physics.

RefCountedPtr< CdrPlasmaStepper >	m_timeStepper
	Time stepper.

RefCountedPtr< AmrMesh >	m_amr
	AmrMesh. Needed for computing tracer stuff.

RefCountedPtr< ComputationalGeometry >	m_computationalGeometry
	Computational geometry. Not needed but useful to have.

int	m_numTracers
	Number of tracer fields.

Vector< EBAMRCellData >	m_tracers
	Tracer fields.

Vector< EBAMRCellData >	m_gradTracers
	Gradient of tracer 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.

Additional Inherited Members
Protected Member Functions inherited from Physics::CdrPlasma::CdrPlasmaFieldTagger
virtual void	allocateStorage () const
	Allocate memory for electric field and scratch.

virtual void	deallocateStorage () const
	Deallocate memory for electric field and scratch.

virtual void	computeElectricField (EBAMRCellData &a_electricField, EBAMRCellData &a_gradientElectricField) const
	Compute electric field onto the input data holders.

Protected Member Functions inherited from Physics::CdrPlasma::CdrPlasmaTagger
virtual void	refineCellsBox (DenseIntVectSet &a_refinedCells, const Vector< EBCellFAB * > &a_tracers, const Vector< EBCellFAB * > &a_gradTracers, 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)
	Per-box refinement method.

virtual void	coarsenCellsBox (DenseIntVectSet &a_coarsenedCells, const Vector< EBCellFAB * > &a_tracers, const Vector< EBCellFAB * > &a_gradTracers, 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)
	Per-box coarsening method.

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

Class which implements CdrPlasmaFieldTagger and refines cells based on the criterion alpha*dx > threshold or on the curvature of the electric field.

Constructor & Destructor Documentation

◆ CdrPlasmaStreamerTagger()

CdrPlasmaStreamerTagger::CdrPlasmaStreamerTagger	(	const RefCountedPtr< CdrPlasmaPhysics > &	a_physics,
		const RefCountedPtr< CdrPlasmaStepper > &	a_timeStepper,
		const RefCountedPtr< AmrMesh > &	a_amr,
		const RefCountedPtr< ComputationalGeometry > &	a_computationalGeometry
	)

Full constructor.

Parameters

[in]	a_physics	Reference to CdrPlasmaPhysics.
[in]	a_timeStepper	Reference to the TimeStepper being used.
[in]	a_amr	Reference to AmrMesh.
[in]	a_computationalGeometry	Computational geometry

Member Function Documentation

◆ coarsenCell()

bool CdrPlasmaStreamerTagger::coarsenCell	(	const RealVect	a_pos,
		const Real	a_time,
		const Real	a_dx,
		const int	a_lvl,
		const Vector< Real >	a_tracers,
		const Vector< RealVect >	a_gradTracers
	)		const

overridevirtual

Cell-coarsening method.

Parameters

[in]	a_pos	Physical position
[in]	a_time	Current time
[in]	a_dx	Grid resolution
[in]	a_lvl	Grid level
[in]	a_tracers	Tracer fields
[in]	a_gradTracers	Gradient of tracer fields

Returns: Return true if the cell should be coarsened and false otherwise.

Implements Physics::CdrPlasma::CdrPlasmaFieldTagger.

◆ parseOptions()

void CdrPlasmaStreamerTagger::parseOptions ( )

overridevirtual

Parse class options.

Implements Physics::CdrPlasma::CdrPlasmaFieldTagger.

◆ parseRuntimeOptions()

void CdrPlasmaStreamerTagger::parseRuntimeOptions ( )

overridevirtual

Parse runtime options.

Reimplemented from CellTagger.

◆ refineCell()

bool CdrPlasmaStreamerTagger::refineCell	(	const RealVect	a_pos,
		const Real	a_time,
		const Real	a_dx,
		const int	a_lvl,
		const Vector< Real >	a_tracers,
		const Vector< RealVect >	a_gradTracers
	)		const

overridevirtual

Cell-refinement method.

Parameters

[in]	a_pos	Physical position
[in]	a_time	Current time
[in]	a_dx	Grid resolution
[in]	a_lvl	Grid level
[in]	a_tracers	Tracer fields
[in]	a_gradTracers	Gradient of tracer fields

Returns: True if the cell should be refined and false otherwise.

Implements Physics::CdrPlasma::CdrPlasmaFieldTagger.

◆ tracer()

Vector< Real > CdrPlasmaStreamerTagger::tracer	(	const RealVect	a_pos,
		const Real	a_time,
		const Real	a_dx,
		const RealVect	a_electricField,
		const Real	a_minElectricField,
		const Real	a_maxElectricField,
		const RealVect	a_gradElectricField,
		const Real	a_minGradElectricField,
		const Real	a_maxGradElectricField
	)		const

overridevirtual

Compute tracer fields.

Parameters

[in]	a_pos	Physical coordinates
[in]	a_time	Time
[in]	a_electricField	Electric field (in SI units)
[in]	a_minElectricField	Minimum value of electric field
[in]	a_maxElectricField	Maximum value of electric field
[in]	a_gradElectricField	Gradient of \|E\|, i.e. grad(\|E\|)
[in]	a_minGradElectricField	Maximum value of \|grad(\|E\|)\|
[in]	a_maxGradElectricField	Maximum value of \|grad(\|E\|)\|

Returns: This should return a Vector of values whose length is equal to the number of tracer fields the subclasses uses.

Implements Physics::CdrPlasma::CdrPlasmaFieldTagger.

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

Physics/CdrPlasma/CellTaggers/CdrPlasmaStreamerTagger/CD_CdrPlasmaStreamerTagger.H
Physics/CdrPlasma/CellTaggers/CdrPlasmaStreamerTagger/CD_CdrPlasmaStreamerTagger.cpp

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ CdrPlasmaStreamerTagger()

Member Function Documentation

◆ coarsenCell()

◆ parseOptions()

◆ parseRuntimeOptions()

◆ refineCell()

◆ tracer()