WARPXM v1.10.0
Loading...
Searching...
No Matches
wxm::apps::viscousmhd::IntraspeciesCyl Class Reference

Implements the source terms for intraspecies collisions arising from a cylindrical geometry. More...

#include <intraspecies_cyl_source.h>

Inheritance diagram for wxm::apps::viscousmhd::IntraspeciesCyl:
WmApplication wxm::app_base

Detailed Description

Implements the source terms for intraspecies collisions arising from a cylindrical geometry.

See collisions writeup document for details.

For the Cartesian flux application intraspecies_collisions_t.

Warpy constructor: warpy.apps.mhd.viscousmhd.viscousmhd.intraspecies_cyl_source

Public Member Functions

 IntraspeciesCyl ()
 
 ~IntraspeciesCyl () override
 
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
 Adiabatic Index.
 
real _charge
 Ion charge of species.
 
real _mass
 Mass of species.
 
real _nuptau
 Normalized collision frequency, needed if using Chodura resistivity.
 
real _coulomb_log
 Coulomb log (defaults to 10).
 
real _collision_coefficient
 
real _minimum_frequency
 Minimum collision frequency (defaults to 0).
 
real _const_mu
 Constant viscosity coefficient (if absent, physical value is computed)
 
bool _ifconst_mu
 
real _const_k
 Constant thermal conductivity coefficient (if absent, physical value is computed)
 
bool _ifconst_k
 
real _min_density
 Density floor.
 
real _min_pressure
 Pressure floor.
 
int _radial_index
 Index of radial component (optional; defaults to 0).
 
int _ir
 
int _ith
 
int _iz
 
std::vector< int > _input_variables
 
std::vector< int > _aux_variables
 
std::vector< int > _output_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

◆ IntraspeciesCyl()

wxm::apps::viscousmhd::IntraspeciesCyl::IntraspeciesCyl ( )

◆ ~IntraspeciesCyl()

wxm::apps::viscousmhd::IntraspeciesCyl::~IntraspeciesCyl ( )
override

Member Function Documentation

◆ getAuxiliaryVariableIndexes()

const std::vector< int > & wxm::apps::viscousmhd::IntraspeciesCyl::getAuxiliaryVariableIndexes ( int  flag) const
inlineoverridevirtual

Reimplemented from WmApplication.

◆ getInputVariableIndexes()

const std::vector< int > & wxm::apps::viscousmhd::IntraspeciesCyl::getInputVariableIndexes ( int  flag) const
inlineoverridevirtual

Reimplemented from wxm::app_base.

◆ getOutputVariableIndexes()

const std::vector< int > & wxm::apps::viscousmhd::IntraspeciesCyl::getOutputVariableIndexes ( int  flag) const
inlineoverridevirtual

Reimplemented from wxm::app_base.

◆ setup()

void wxm::apps::viscousmhd::IntraspeciesCyl::setup ( const WxCryptSet wxc)
overridevirtual

Reimplemented from WmApplication.

◆ source()

real wxm::apps::viscousmhd::IntraspeciesCyl::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::viscousmhd::IntraspeciesCyl::_aux_variables
protected

◆ _charge

real wxm::apps::viscousmhd::IntraspeciesCyl::_charge
protected

Ion charge of species.

◆ _collision_coefficient

real wxm::apps::viscousmhd::IntraspeciesCyl::_collision_coefficient
protected

◆ _const_k

real wxm::apps::viscousmhd::IntraspeciesCyl::_const_k
protected

Constant thermal conductivity coefficient (if absent, physical value is computed)

◆ _const_mu

real wxm::apps::viscousmhd::IntraspeciesCyl::_const_mu
protected

Constant viscosity coefficient (if absent, physical value is computed)

◆ _coulomb_log

real wxm::apps::viscousmhd::IntraspeciesCyl::_coulomb_log
protected

Coulomb log (defaults to 10).

◆ _gas_gamma

real wxm::apps::viscousmhd::IntraspeciesCyl::_gas_gamma
protected

Adiabatic Index.

◆ _ifconst_k

bool wxm::apps::viscousmhd::IntraspeciesCyl::_ifconst_k
protected

◆ _ifconst_mu

bool wxm::apps::viscousmhd::IntraspeciesCyl::_ifconst_mu
protected

◆ _input_variables

std::vector<int> wxm::apps::viscousmhd::IntraspeciesCyl::_input_variables
protected

◆ _ir

int wxm::apps::viscousmhd::IntraspeciesCyl::_ir
protected

◆ _ith

int wxm::apps::viscousmhd::IntraspeciesCyl::_ith
protected

◆ _iz

int wxm::apps::viscousmhd::IntraspeciesCyl::_iz
protected

◆ _mass

real wxm::apps::viscousmhd::IntraspeciesCyl::_mass
protected

Mass of species.

◆ _min_density

real wxm::apps::viscousmhd::IntraspeciesCyl::_min_density
protected

Density floor.

◆ _min_pressure

real wxm::apps::viscousmhd::IntraspeciesCyl::_min_pressure
protected

Pressure floor.

◆ _minimum_frequency

real wxm::apps::viscousmhd::IntraspeciesCyl::_minimum_frequency
protected

Minimum collision frequency (defaults to 0).

◆ _nuptau

real wxm::apps::viscousmhd::IntraspeciesCyl::_nuptau
protected

Normalized collision frequency, needed if using Chodura resistivity.

◆ _output_variables

std::vector<int> wxm::apps::viscousmhd::IntraspeciesCyl::_output_variables
protected

◆ _radial_index

int wxm::apps::viscousmhd::IntraspeciesCyl::_radial_index
protected

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.


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