criptic v1
Cosmic Ray Interstellar Propagation Tool using Itô Calculus
Loading...
Searching...
No Matches
Public Member Functions | Private Attributes | List of all members
criptic::gas::UniformGas Class Reference

A class to describe a uniform background gas. More...

#include <UniformGas.H>

Inheritance diagram for criptic::gas::UniformGas:
criptic::gas::Gas

Public Member Functions

 UniformGas (const ParmParser &pp)
 Construct a uniform gas by reading from input deck.
 
virtual ~UniformGas ()
 Virtual destructor – does nothing.
 
virtual void frame (const RealVec &x, const Real t, RealVec &v, TNBBasis &tnb) const override
 Compute the comoving TNB frame for the gas.
 
virtual GasData gasData (const RealVec &x, const Real t) const override
 Return background gas state.
 
- Public Member Functions inherited from criptic::gas::Gas
virtual ~Gas ()
 Empty virtual destructor.
 
virtual Real dxGhost () const
 Size of the ghost region in the gas data.
 
virtual void updateState (const Real t, Real &tNext)
 Update the gas data.
 

Private Attributes

TNBBasis b
 
GasData gd
 

Detailed Description

A class to describe a uniform background gas.

This class represents a uniform background gas. The properties of the gas are read from the input deck.

Constructor & Destructor Documentation

◆ UniformGas()

criptic::gas::UniformGas::UniformGas ( const ParmParser pp)
inline

Construct a uniform gas by reading from input deck.

Parameters
ppcriptic::ParmParser containing the input deck

◆ ~UniformGas()

virtual criptic::gas::UniformGas::~UniformGas ( )
inlinevirtual

Virtual destructor – does nothing.

Member Function Documentation

◆ frame()

virtual void criptic::gas::UniformGas::frame ( const RealVec x,
const Real  t,
RealVec v,
TNBBasis tnb 
) const
inlineoverridevirtual

Compute the comoving TNB frame for the gas.

Parameters
xPosition
tTime
vComoving velocity at specified position and time
tnbThe TNBBasis at the specified position and time

This function computes the comoving TNB frame for the gas at a specified position and time.

Reimplemented from criptic::gas::Gas.

◆ gasData()

virtual GasData criptic::gas::UniformGas::gasData ( const RealVec x,
const Real  t 
) const
inlineoverridevirtual

Return background gas state.

Parameters
xPosition
tTime
Returns
GasData at specified (x, t)

Implements criptic::gas::Gas.

Member Data Documentation

◆ b

TNBBasis criptic::gas::UniformGas::b
private

TNB basis information

◆ gd

GasData criptic::gas::UniformGas::gd
private

Description of the uniform gas state


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