ryujin::ElectrostaticConfiguration< dim, Number > Class Template Reference

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

Inheritance diagram for ryujin::ElectrostaticConfiguration< dim, Number >:

Collaboration diagram for ryujin::ElectrostaticConfiguration< dim, Number >:

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

Public Member Functions
	ElectrostaticConfiguration (const std::string &name, const std::string &subsection)
virtual double	background_density (const dealii::Point< dim > &point, Number t) const =0
virtual curl_type	magnetic_field (const dealii::Point< dim > &point, Number t) const =0

Protected Attributes
bool	is_time_dependent_

Detailed Description

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

A small abstract base class to group configuration options for an electrostatic configuration

Definition at line 27 of file electrostatic_configuration.h.

Member Typedef Documentation

curl_type

template<int dim, typename Number = double>

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

Definition at line 30 of file electrostatic_configuration.h.

Constructor & Destructor Documentation

ElectrostaticConfiguration()

template<int dim, typename Number = double>

ryujin::ElectrostaticConfiguration< dim, Number >::ElectrostaticConfiguration ( const std::string &  name, const std::string &  subsection  )

inline

Definition at line 32 of file electrostatic_configuration.h.

References ryujin::dirichlet, ryujin::dirichlet_momentum, ryujin::dirichlet_velocity, ryujin::do_nothing, ryujin::dynamic, ryujin::ElectrostaticConfiguration< dim, Number >::is_time_dependent_, ryujin::no_slip, and ryujin::slip.

Member Function Documentation

background_density()

template<int dim, typename Number = double>

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

pure virtual

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

Implemented in ryujin::ElectrostaticConfigurations::Constant< dim, Number >, and ryujin::ElectrostaticConfigurations::Function< dim, Number >.

magnetic_field()

template<int dim, typename Number = double>

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

pure virtual

Return a background magnetic field.

Implemented in ryujin::ElectrostaticConfigurations::Constant< dim, Number >, and ryujin::ElectrostaticConfigurations::Function< dim, Number >.

Member Data Documentation

is_time_dependent_

template<int dim, typename Number = double>

bool ryujin::ElectrostaticConfiguration< dim, Number >::is_time_dependent_

protected

Return the name of the configuration as a (const reference) std::string. Return the selected boundary type. Return a boolean indicating whether the background fields are time dependent.

Definition at line 84 of file electrostatic_configuration.h.

Referenced by ryujin::ElectrostaticConfiguration< dim, Number >::ElectrostaticConfiguration(), and ryujin::ElectrostaticConfigurations::Function< dim, Number >::Function().

---

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

• include/ryujin/euler_poisson/electrostatic_configuration.h