wxm::apps::imhd::CylSource Class Reference

Implements the source terms in the Ideal MHD equations arising from a cylindrical geometry. More...

#include <cyl_source.h>

Inheritance diagram for wxm::apps::imhd::CylSource:

Detailed Description

Implements the source terms in the Ideal MHD equations arising from a cylindrical geometry.

Warpy constructor: warpy.apps.mhd.imhd.imhd.cyl_source

Parameters

gamma	Gas Gamma (Adiabatic Index)
min_radius_equals_zero	true if minimum radius is 0 (optional; defaults to false)
radial_index	index of radial component (optional; defaults to 0) To configure the coordinate systems as [r,theta,z] or [z,r,theta], set this variable to either 0 or 1, respectively.
min_density	Density floor (optional; defaults to 0)
min_pressure	Pressure floor (optional; defaults to 0)
fluid	Fluid variable
fluid_gradient	Fluid gradient variable. Note that the fluid gradient variable must be present. However, if min_radius_equals_zero is false, the gradient variable may be a dummy variable, i.e., initialized, but not computed. There should be no significant computational expense to create and pass such a variable. The need for such a dummy variable could be eliminated if optional variable passing were possible.
fluid_components	Components of fluid variable
gradient_components	Components of fluid gradient variable.

Public Member Functions
	CylSource ()
	~CylSource ()
void	setup (const WxCryptSet &wxc) override
const std::vector< int > &	getInputVariableIndexes (int flag) const override
const std::vector< int > &	getAuxiliaryVariableIndexes (int flag) const override
const std::vector< int > &	getOutputVariableIndexes (int flag) const override
real	source (const real *q, const real *aux, const elementGeometry_t *pEG, real *source) const override
Public Member Functions inherited from WmApplication
	WmApplication ()
virtual	~WmApplication ()=default
virtual void	setup (const WxCryptSet &wxc)
virtual const std::vector< int > &	getAuxiliaryVariableIndexes (int flag=WMAPPLICATIONFLAG_NONE) const
virtual const std::vector< int > &	getCrossVariableIndexes (int flag=WMAPPLICATIONFLAG_NONE) const
const std::vector< std::string > &	getBoundaryNames () const
bool	isOnBoundary (const std::string &boundaryName) const
bool	has (int flag) const
virtual real	numerical_flux (const real *q_l, const real *q_r, const real *aux_l, const real *aux_r, const solverVariables_t *pFV, real *numericalFlux) const
virtual real	internal_flux (const real *q, const real *aux, const solverVariables_t *pSV, std::vector< std::vector< real > > &internalFlux) const
virtual real	source (const real *q, const real *aux, const elementGeometry_t *pEG, real *source) const
virtual void	bc_q (const real *q_in, const real *aux_in, const real *aux_out, const solverVariables_t *pFV, real *q_out) const
	Boundary Condition Application which sets the boundary condition on ghost nodes.
virtual real	bcNumericalFlux (const real *q_l, const real *q_r, const real *aux_l, const real *aux_r, const solverVariables_t *pFV, real *numericalFlux) const
virtual void	conserved_to_primitive (const real *q, const real *aux, real *w) const
virtual void	primitive_to_conserved (const real *w, const real *aux, real *q) const
virtual void	evaluate_function (const real *q, const real *aux, const solverVariables_t *pSV, real *result) const
virtual void	bc_q_kinetic (const real *q_in, const real *aux_in, const solverVariables_t *pFV, real *q_out) const
std::shared_ptr< std::string >	app_name ()
virtual const std::vector< int > &	getInputVariableIndexes (int flag=0) const
virtual const std::vector< int > &	getOutputVariableIndexes (int flag=0) const

Protected Attributes
real	_gas_gamma
real	_min_density
real	_min_pressure
int	_radial_index
int	_ir
int	_ith
int	_iz
bool	_rmin_eq_0
std::vector< int >	_input_variables
std::vector< int >	_aux_variables
Protected Attributes inherited from WmApplication
std::string	_app_name
WxLogStream	_debStrm
std::vector< int >	_allowedFlags
std::vector< std::string >	_onBoundaries

Additional Inherited Members
Public Types inherited from WmApplication
typedef Application_Variable	WmApplication_Variable
typedef std::map< std::string, std::string >	replaceMap_t
Static Public Attributes inherited from wxm::app_base
static std::vector< int >	empty
Protected Member Functions inherited from wxm::app_base
virtual	~app_base ()=default

Constructor & Destructor Documentation

CylSource()

wxm::apps::imhd::CylSource::CylSource

(

)

~CylSource()

wxm::apps::imhd::CylSource::~CylSource

(

)

Member Function Documentation

getAuxiliaryVariableIndexes()

const std::vector< int > & wxm::apps::imhd::CylSource::getAuxiliaryVariableIndexes ( int  flag ) const

inlineoverridevirtual

Reimplemented from WmApplication.

getInputVariableIndexes()

const std::vector< int > & wxm::apps::imhd::CylSource::getInputVariableIndexes ( int  flag ) const

inlineoverridevirtual

Reimplemented from wxm::app_base.

getOutputVariableIndexes()

const std::vector< int > & wxm::apps::imhd::CylSource::getOutputVariableIndexes ( int  flag ) const

inlineoverridevirtual

Reimplemented from wxm::app_base.

setup()

void wxm::apps::imhd::CylSource::setup ( const WxCryptSet &  wxc )

overridevirtual

Reimplemented from WmApplication.

source()

real wxm::apps::imhd::CylSource::source ( const real *  q, const real *  aux, const elementGeometry_t *  pEG, real *  source  ) const

overridevirtual

Reimplemented from WmApplication.

Member Data Documentation

_aux_variables

std::vector<int> wxm::apps::imhd::CylSource::_aux_variables

protected

_gas_gamma

real wxm::apps::imhd::CylSource::_gas_gamma

protected

_input_variables

std::vector<int> wxm::apps::imhd::CylSource::_input_variables

protected

_ir

int wxm::apps::imhd::CylSource::_ir

protected

_ith

int wxm::apps::imhd::CylSource::_ith

protected

_iz

int wxm::apps::imhd::CylSource::_iz

protected

_min_density

real wxm::apps::imhd::CylSource::_min_density

protected

_min_pressure

real wxm::apps::imhd::CylSource::_min_pressure

protected

_radial_index

int wxm::apps::imhd::CylSource::_radial_index

protected

_rmin_eq_0

bool wxm::apps::imhd::CylSource::_rmin_eq_0

protected

---

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

• src/apps/mhd/imhd/cyl_source.h