CellTagger for the DischargeInception module. More...

#include <CD_DischargeInceptionTagger.H>

Inheritance diagram for Physics::DischargeInception::DischargeInceptionTagger:

Collaboration diagram for Physics::DischargeInception::DischargeInceptionTagger:

Public Member Functions
	DischargeInceptionTagger ()=delete
	Disallowed constructor.

	DischargeInceptionTagger (const DischargeInceptionTagger &)=delete
	Disallowed constructor.

	DischargeInceptionTagger (const DischargeInceptionTagger &&)=delete
	Disallowed constructor.

	DischargeInceptionTagger (const RefCountedPtr< AmrMesh > &a_amrMesh, const EBAMRCellData *const a_electricField, const std::function< Real(const Real E, const RealVect x)> &a_alphaEff, const phase::which_phase a_phase=phase::gas)
	Full constructor.

virtual	~DischargeInceptionTagger ()
	Destructor.

virtual void	parseOptions () override final
	Parse options.

virtual void	regrid () override final
	Regrid hook. Re-allocates internal data holders after the AMR hierarchy changes.

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

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

virtual void	writePlotData (EBAMRCellData &a_output, Vector< std::string > &a_plotVariableNames, int &a_icomp) const
	Write plot data.

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 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 Member Functions
virtual void	computeTracerField () const noexcept
	Compute alpha_eff*dx at max voltage.

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
RefCountedPtr< AmrMesh >	m_amr
	AmrMesh reference.

const EBAMRCellData *	m_electricField
	Pointer to electric field.

EBAMRCellData	m_tracerField
	Tracer field. Will be populated with \|grad(E)\|*dx/\|E\|.

std::function< Real(const Real &E, const RealVect x)>	m_alphaEff
	Net effective ionization coefficient \( \alpha_\mathrm{eff}(E, x) \) callable.

phase::which_phase	m_phase
	Phase (gas/solid) on which the tagger operates.

std::string	m_realm
	Realm name where solver data lives.

Real	m_refAlpha
	Threshold for refinement: refine if \( \alpha_\mathrm{eff} \cdot \Delta x > m\_refAlpha \).

Real	m_maxVoltage
	Reference voltage used to scale the electric field when computing the tracer field.

bool	m_plot
	If true, write the tracer field to the plot file.

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

CellTagger for the DischargeInception module.

Flags cells for refinement where the effective ionization coefficient scaled by the local grid spacing exceeds a threshold: \( \alpha_\mathrm{eff} \cdot \Delta x > \text{threshold} \). The effective ionization coefficient \( \alpha_\mathrm{eff}(E, \mathbf{x}) \) is supplied by the caller and is typically the net Townsend coefficient \( \alpha - \eta \).

Constructor & Destructor Documentation

◆ DischargeInceptionTagger()

DischargeInceptionTagger::DischargeInceptionTagger	(	const RefCountedPtr< AmrMesh > &	a_amrMesh,
		const EBAMRCellData *const	a_electricField,
		const std::function< Real(const Real E, const RealVect x)> &	a_alphaEff,
		const phase::which_phase	a_phase = `phase::gas`
	)

Full constructor.

Parameters

[in]	a_amrMesh	AMR mesh.
[in]	a_electricField	Pointer to the cell-centred electric field data (not owned).
[in]	a_alphaEff	Net effective ionization coefficient as a function of field magnitude E and position x.
[in]	a_phase	Phase (gas/solid) on which the tagger operates.

Member Function Documentation

◆ getNumberOfPlotVariables()

int DischargeInceptionTagger::getNumberOfPlotVariables ( ) const

overridevirtual

Get number of plot variables that will be written to file (by Driver).

Returns: Returns number of plot variables that Driver will write to plot files.

Reimplemented from CellTagger.

◆ parseOptions()

void DischargeInceptionTagger::parseOptions ( )

finaloverridevirtual

Parse options.

Implements CellTagger.

◆ regrid()

void DischargeInceptionTagger::regrid ( )

finaloverridevirtual

Regrid hook. Re-allocates internal data holders after the AMR hierarchy changes.

Implements CellTagger.

◆ tagCells()

bool DischargeInceptionTagger::tagCells ( EBAMRTags & a_tags )

finaloverridevirtual

Tag cells for refinement.

This tags based on |grad(E)|*dx/E.

Parameters

[in,out] a_tags Tags on grid levels.

Returns: Return value

Implements CellTagger.

◆ writePlotData()

void DischargeInceptionTagger::writePlotData	(	EBAMRCellData &	a_output,
		Vector< std::string > &	a_plotVariableNames,
		int &	a_icomp
	)		const

virtual

Write plot data.

Parameters

[in,out]	a_output	Output data holder
[in,out]	a_plotVariableNames	Plot variable names
[in,out]	a_icomp	Starting variable in a_output where we begin appending data.

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

Physics/DischargeInception/CD_DischargeInceptionTagger.H
Physics/DischargeInception/CD_DischargeInceptionTagger.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ DischargeInceptionTagger()

Member Function Documentation

◆ getNumberOfPlotVariables()

◆ parseOptions()

◆ regrid()

◆ tagCells()

◆ writePlotData()