Sapphire++
 v1.3.0-121-g2682132
Loading...
Searching...
No Matches
sapphirepp::VFP::InitialValueFunction< dim > Class Template Reference

Initial condition. More...

#include <config.h>

Inheritance diagram for sapphirepp::VFP::InitialValueFunction< dim >:
[legend]
Collaboration diagram for sapphirepp::VFP::InitialValueFunction< dim >:
[legend]

Public Member Functions

 InitialValueFunction (const PhysicalParameters &physical_parameters, const unsigned int system_size)
 Constructor.
void vector_value (const dealii::Point< dim > &point, dealii::Vector< double > &f) const override
 Evaluate the initial condition at point p.

Detailed Description

template<unsigned int dim>
class sapphirepp::VFP::InitialValueFunction< dim >

Initial condition.

[VFP Flags]

Template Parameters
dimDimension of the reduced phase space \( (\mathbf{x}, p) \)

Constructor & Destructor Documentation

◆ InitialValueFunction()

template<unsigned int dim>
sapphirepp::VFP::InitialValueFunction< dim >::InitialValueFunction ( const PhysicalParameters & physical_parameters,
const unsigned int system_size )
inline

Constructor.

Parameters
physical_parametersUser defined runtime parameters
system_sizeNumber of expansion coefficients, normally \( (l_{\rm max} + 1)^2 \)

Member Function Documentation

◆ vector_value()

template<unsigned int dim>
void sapphirepp::VFP::InitialValueFunction< dim >::vector_value ( const dealii::Point< dim > & point,
dealii::Vector< double > & f ) const
inlineoverride

Evaluate the initial condition at point p.

Return a vector of values corresponding to the initial condition of the coefficients \( f_{i(l,m,s)}(t=0, \mathbf{x}, p) \) of the expansion of the distribution function in spherical harmonics.

The zeroth component of values corresponds to \( f_{000} \), the first component to \( f_{110} \) etc. The mapping between the system index \( i \) and the spherical harmonic indices \( (l,m,s) \) is given by lms_indices:

const unsigned int l = lms_indices[i][0];
const unsigned int m = lms_indices[i][1];
const unsigned int s = lms_indices[i][2];

The point in reduced phase space is given by p. The first dim_cs components correspond to the spatial coordinates \( \mathbf{x} \) and if momentum term is activated the last component to the momentum coordinate \( p \):

const double x = point[0];
const double y = point[1];
// ...
const double log_p = point[dim-1];
Parameters
pointPoint in reduced phase space
fReturn vector \( f_{i(l,m,s)}(t=0, \mathbf{x}, p) \)
See also
Function::vector_value()

[Initial value]

[Initial value]


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