sapphirepp::VFP::BackgroundVelocityField< dim > Class Template Reference

Background velocity field. More...

#include <config.h>

Inheritance diagram for sapphirepp::VFP::BackgroundVelocityField< dim >:

Collaboration diagram for sapphirepp::VFP::BackgroundVelocityField< dim >:

Public Member Functions
	BackgroundVelocityField (const PhysicalParameters &physical_parameters)
	Constructor.
void	vector_value (const dealii::Point< dim > &point, dealii::Vector< double > &velocity) const override
	Evaluate the velocity field at a point p.
void	divergence_list (const std::vector< dealii::Point< dim > > &points, std::vector< double > &divergence) const
	Evaluate the divergence of the velocity field.
void	material_derivative_list (const std::vector< dealii::Point< dim > > &points, std::vector< dealii::Vector< double > > &material_derivatives) const
	Evaluate the material derivative of the velocity field.
void	jacobian_list (const std::vector< dealii::Point< dim > > &points, std::vector< dealii::FullMatrix< double > > &jacobians) const
	Evaluate the Jacobian matrix of the velocity field.

Detailed Description

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

Background velocity field.

Template Parameters

dim	Dimension of the reduced phase space \( (\mathbf{x}, p) \)

Constructor & Destructor Documentation

BackgroundVelocityField()

template<unsigned int dim>

sapphirepp::VFP::BackgroundVelocityField< dim >::BackgroundVelocityField ( const PhysicalParameters & physical_parameters )

inline

Constructor.

Parameters

physical_parameters

User defined runtime parameters

Member Function Documentation

divergence_list()

template<unsigned int dim>

void sapphirepp::VFP::BackgroundVelocityField< dim >::divergence_list ( const std::vector< dealii::Point< dim > > & points, std::vector< double > & divergence ) const

inline

Evaluate the divergence of the velocity field.

Return a vector of values corresponding to the divergence of the velocity field \( \nabla \cdot \mathbf{u}(t, \mathbf{x}) \) at all points in space.

Parameters

points	List of points in reduced phase space
divergence	List of divergence values

See also

ScatteringFrequency::value_list()

MagneticField::vector_value()

Function::value_list()

[Background velocity divergence]

[Background velocity divergence]

jacobian_list()

template<unsigned int dim>

void sapphirepp::VFP::BackgroundVelocityField< dim >::jacobian_list ( const std::vector< dealii::Point< dim > > & points, std::vector< dealii::FullMatrix< double > > & jacobians ) const

inline

Evaluate the Jacobian matrix of the velocity field.

Return a vector of matrices corresponding to the Jacobian matrix of the velocity field \( \nabla \mathbf{u}(t, \mathbf{x}) \) at all points in space.

Parameters

points	List of points in reduced phase space
jacobians	List of Jacobian matrices

See also

ScatteringFrequency::value_list()

MagneticField::vector_value()

Function::value_list()

[Background velocity Jacobian]

[Background velocity Jacobian]

material_derivative_list()

template<unsigned int dim>

void sapphirepp::VFP::BackgroundVelocityField< dim >::material_derivative_list ( const std::vector< dealii::Point< dim > > & points, std::vector< dealii::Vector< double > > & material_derivatives ) const

inline

Evaluate the material derivative of the velocity field.

Return a vector of values corresponding to the material derivative of the velocity field \( \frac{\mathrm{D} \mathbf{u}}{\mathrm{D} t} \) at all points in space.

Parameters

points	List of points in reduced phase space
material_derivatives	List of material derivative values

See also

ScatteringFrequency::value_list()

MagneticField::vector_value()

Function::value_list()

[Background velocity material derivative]

[Background velocity material derivative]

vector_value()

template<unsigned int dim>

void sapphirepp::VFP::BackgroundVelocityField< dim >::vector_value ( const dealii::Point< dim > & point, dealii::Vector< double > & velocity ) const

inlineoverride

Evaluate the velocity field at a point p.

Return a vector of values corresponding to the velocity field \( \mathbf{u}(t, \mathbf{x}) \) at point in space.

Parameters

point	Point in reduced phase space
velocity	Return vector \( \mathbf{u}(t, \mathbf{x}) \)

See also

MagneticField::vector_value()

Function::vector_value()

[Background velocity value]

[Background velocity value]

---

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

• include/config.h