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

A propagation model where all propagation parameters are zero. More...

#include <NoPropagation.H>

Inheritance diagram for criptic::propagation::NoPropagation:
criptic::propagation::Propagation

Public Member Functions

 NoPropagation (const ParmParser &pp)
 Constructor.
 
virtual ~NoPropagation ()
 Empty virtual destructor.
 
virtual FieldQtyNeedType fieldQtyNeed () const
 Access to field quantities needed?
 
virtual PropagationData operator() (const RealVec &x, const Real t, const gas::GasData &gd, const CRPacket &packet, const FieldQty &qty, const FieldQtyGrad &qtyGrad) const
 Return the propagation data.
 
- Public Member Functions inherited from criptic::propagation::Propagation
 Propagation (const ParmParser &pp)
 Constructor.
 
virtual ~Propagation ()
 Empty virtual destructor.
 
void applyLimits (const gas::GasData &gd, const CRPacket &packet, PropagationData &pd) const
 Apply the Bohm limit and manually-set limits.
 

Detailed Description

A propagation model where all propagation parameters are zero.

Constructor & Destructor Documentation

◆ NoPropagation()

criptic::propagation::NoPropagation::NoPropagation ( const ParmParser pp)
inline

Constructor.

Parameters
ppcriptic::ParmParser containing the input deck

◆ ~NoPropagation()

virtual criptic::propagation::NoPropagation::~NoPropagation ( )
inlinevirtual

Empty virtual destructor.

Member Function Documentation

◆ fieldQtyNeed()

virtual FieldQtyNeedType criptic::propagation::NoPropagation::fieldQtyNeed ( ) const
inlinevirtual

Access to field quantities needed?

Returns
Level of field quantity information required

Implements criptic::propagation::Propagation.

◆ operator()()

criptic::propagation::NoPropagation::operator() ( const RealVec x,
const Real  t,
const gas::GasData gd,
const CRPacket packet,
const FieldQty qty,
const FieldQtyGrad qtyGrad 
) const
inlinevirtual

Return the propagation data.

Parameters
xPosition
tTime
gdData on background gas state
packetPacket data
qtyField quantities at the specified (x,t)
qtyGradGradients of field quantities at specified (x,t)
Returns
The propagation data for the specified CR and point

Implements criptic::propagation::Propagation.


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