ryujin::ElectrostaticConfigurations::Function< dim, Number > Class Template Reference

#include <include/ryujin/euler_poisson/electrostatic_configuration_function.h>

Inheritance diagram for ryujin::ElectrostaticConfigurations::Function< dim, Number >:

Collaboration diagram for ryujin::ElectrostaticConfigurations::Function< dim, Number >:

Public Types
using	curl_type = ElectrostaticConfiguration< dim, Number >::curl_type
Public Types inherited from ryujin::ElectrostaticConfiguration< dim, Number >
using	curl_type = dealii::Tensor< 1, dim==2 ? 1 :dim, Number >

Public Member Functions
	Function (const std::string &subsection)
virtual double	background_density (const dealii::Point< dim > &point, Number t) const final
virtual curl_type	magnetic_field (const dealii::Point< dim > &point, Number t) const final
Public Member Functions inherited from ryujin::ElectrostaticConfiguration< dim, Number >
	ElectrostaticConfiguration (const std::string &name, const std::string &subsection)

Additional Inherited Members
Protected Attributes inherited from ryujin::ElectrostaticConfiguration< dim, Number >
bool	is_time_dependent_

Detailed Description

template<int dim, typename Number = double>
class ryujin::ElectrostaticConfigurations::Function< dim, Number >

A user-specified equation of state

Definition at line 23 of file electrostatic_configuration_function.h.

Member Typedef Documentation

curl_type

template<int dim, typename Number = double>

using ryujin::ElectrostaticConfigurations::Function< dim, Number >::curl_type = ElectrostaticConfiguration<dim, Number>::curl_type

Definition at line 26 of file electrostatic_configuration_function.h.

Constructor & Destructor Documentation

Function()

template<int dim, typename Number = double>

ryujin::ElectrostaticConfigurations::Function< dim, Number >::Function ( const std::string &  subsection )

inline

Definition at line 28 of file electrostatic_configuration_function.h.

References ryujin::ElectrostaticConfiguration< dim, Number >::is_time_dependent_.

Member Function Documentation

background_density()

template<int dim, typename Number = double>

virtual double ryujin::ElectrostaticConfigurations::Function< dim, Number >::background_density ( const dealii::Point< dim > &  point, Number  t  ) const

inlinefinalvirtual

Return a background (charge) density that is added to the (fluid) density when enforcing the Gauß law.

Implements ryujin::ElectrostaticConfiguration< dim, Number >.

Definition at line 94 of file electrostatic_configuration_function.h.

magnetic_field()

template<int dim, typename Number = double>

virtual curl_type ryujin::ElectrostaticConfigurations::Function< dim, Number >::magnetic_field ( const dealii::Point< dim > &  point, Number  t  ) const

inlinefinalvirtual

Return a background magnetic field.

Implements ryujin::ElectrostaticConfiguration< dim, Number >.

Definition at line 101 of file electrostatic_configuration_function.h.

---

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

• include/ryujin/euler_poisson/electrostatic_configuration_function.h