ryujin 2.1.1 revision 955e869188d49b3c97ca7b1cf4fd9ceb0e6f46ef
Public Types | Public Member Functions | List of all members
ryujin::Discretization< dim > Class Template Reference

#include <source/discretization.h>

Inheritance diagram for ryujin::Discretization< dim >:
Inheritance graph
[legend]
Collaboration diagram for ryujin::Discretization< dim >:
Collaboration graph
[legend]

Public Types

using Triangulation = typename Proxy< dim >::Triangulation
 

Public Member Functions

 Discretization (const MPIEnsemble &mpi_ensemble, const std::string &subsection="/Discretization")
 
void prepare (const std::string &base_name)
 

Accessors to data structures managed by this class.

const MPIEnsemblempi_ensemble_
 
std::unique_ptr< Triangulationtriangulation_
 
std::unique_ptr< const dealii::Mapping< dim > > mapping_
 
std::unique_ptr< const dealii::FiniteElement< dim > > finite_element_
 
std::unique_ptr< const dealii::FiniteElement< dim > > finite_element_cg_
 
std::unique_ptr< const dealii::Quadrature< dim > > quadrature_
 
std::unique_ptr< const dealii::Quadrature< dim > > nodal_quadrature_
 
std::unique_ptr< const dealii::Quadrature< 1 > > quadrature_1d_
 
std::unique_ptr< const dealii::Quadrature< dim - 1 > > face_quadrature_
 
std::unique_ptr< const dealii::Quadrature< dim - 1 > > face_nodal_quadrature_
 
const auto & ansatz () const
 
bool have_discontinuous_ansatz () const
 
const auto & triangulation () const
 
const auto & mapping () const
 
const auto & finite_element () const
 
const auto & finite_element_cg () const
 
const auto & quadrature () const
 
const auto & nodal_quadrature () const
 
const auto & quadrature_1d () const
 
const auto & face_quadrature () const
 
const auto & face_nodal_quadrature () const
 

Internal data:

template<typename Discretization , int dim_, typename Number_ >
class SolutionTransfer
 

Detailed Description

template<int dim>
class ryujin::Discretization< dim >

This class is as a container for data related to the discretization, this includes the triangulation, finite element, mapping, and quadrature. After prepare() is called, the getter functions Discretization::triangulation(), Discretization::finite_element(), Discretization::mapping(), and Discretization::quadrature() return valid const references to the mentioned objects.

The class uses dealii::ParameterAcceptor to handle a multitude of parameters to control the creation of meshes for a variety of benchmark configurations and to read in meshes in one of the formats supported by the deal.II library.

Definition at line 209 of file discretization.h.

Member Typedef Documentation

◆ Triangulation

template<int dim>
using ryujin::Discretization< dim >::Triangulation = typename Proxy<dim>::Triangulation

A type alias denoting the Triangulation we are using:

In one spatial dimensions we use a dealii::parallel::shared::Triangulation and for two and three dimensions a dealii::parallel::distributed::Triangulation.

Definition at line 219 of file discretization.h.

Constructor & Destructor Documentation

◆ Discretization()

template<int dim>
ryujin::Discretization< dim >::Discretization ( const MPIEnsemble mpi_ensemble,
const std::string &  subsection = "/Discretization< dim >" 
)

Constructor.

Definition at line 26 of file discretization.template.h.

References ryujin::cg_q1.

Member Function Documentation

◆ prepare()

template<int dim>
void ryujin::Discretization< dim >::prepare ( const std::string &  base_name)

Create the triangulation and set up the finite element, mapping and quadrature objects.

Definition at line 64 of file discretization.template.h.

References ryujin::cg_q1, ryujin::cg_q2, ryujin::cg_q3, ryujin::dg_q1, ryujin::dg_q2, and ryujin::dg_q3.

◆ ansatz()

template<int dim>
const auto & ryujin::Discretization< dim >::ansatz ( ) const
inline

Return a read-only const reference to the finite element ansatz.

Definition at line 241 of file discretization.h.

◆ have_discontinuous_ansatz()

template<int dim>
bool ryujin::Discretization< dim >::have_discontinuous_ansatz ( ) const
inline

Return a boolean indicating whether the chosen Ansatz space is discontinuous.

Definition at line 248 of file discretization.h.

References ryujin::cg_q1, ryujin::cg_q2, ryujin::cg_q3, ryujin::dg_q1, ryujin::dg_q2, and ryujin::dg_q3.

◆ triangulation()

template<int dim>
const auto & ryujin::Discretization< dim >::triangulation ( ) const
inline

Return a mutable reference to the refinement variable. Return a mutable reference to the triangulation. Return a read-only const reference to the triangulation.

Definition at line 285 of file discretization.h.

◆ mapping()

template<int dim>
const auto & ryujin::Discretization< dim >::mapping ( ) const
inline

Return a read-only const reference to the mapping.

Definition at line 290 of file discretization.h.

◆ finite_element()

template<int dim>
const auto & ryujin::Discretization< dim >::finite_element ( ) const
inline

Return a read-only const reference to the finite element.

Definition at line 295 of file discretization.h.

◆ finite_element_cg()

template<int dim>
const auto & ryujin::Discretization< dim >::finite_element_cg ( ) const
inline

Return a read-only const reference to a continuous ("cG") variant of the selected discontinuous finite element space.

Note
This object is unavailable for the dG Q0 discretization.

Definition at line 303 of file discretization.h.

◆ quadrature()

template<int dim>
const auto & ryujin::Discretization< dim >::quadrature ( ) const
inline

Return a read-only const reference to the quadrature rule.

Definition at line 308 of file discretization.h.

◆ nodal_quadrature()

template<int dim>
const auto & ryujin::Discretization< dim >::nodal_quadrature ( ) const
inline

Return a read-only const reference to the nodal quadrature rule (Gauß Lobatto).

Definition at line 314 of file discretization.h.

◆ quadrature_1d()

template<int dim>
const auto & ryujin::Discretization< dim >::quadrature_1d ( ) const
inline

Return a read-only const reference to the 1D quadrature rule.

Definition at line 319 of file discretization.h.

◆ face_quadrature()

template<int dim>
const auto & ryujin::Discretization< dim >::face_quadrature ( ) const
inline

Return a read-only const reference to the face quadrature rule.

Definition at line 324 of file discretization.h.

◆ face_nodal_quadrature()

template<int dim>
const auto & ryujin::Discretization< dim >::face_nodal_quadrature ( ) const
inline

Return a read-only const reference to the nodal face quadrature rule (Gauß Lobatto).

Definition at line 330 of file discretization.h.

Friends And Related Function Documentation

◆ SolutionTransfer

template<int dim>
template<typename Discretization , int dim_, typename Number_ >
friend class SolutionTransfer
friend

In the SolutionTransfer class we need writable access to the triangulation object in order to prepare data for mesh adaptation and checkpointing / restart. Work around this issue by declaring the solution transfer class to be a friend rather than changing the constructor, or augmenting the methods in SolutionTransfer.

Definition at line 379 of file discretization.h.

Member Data Documentation

◆ mpi_ensemble_

template<int dim>
const MPIEnsemble& ryujin::Discretization< dim >::mpi_ensemble_
protected

Definition at line 333 of file discretization.h.

◆ triangulation_

template<int dim>
std::unique_ptr<Triangulation> ryujin::Discretization< dim >::triangulation_
protected

Definition at line 335 of file discretization.h.

◆ mapping_

template<int dim>
std::unique_ptr<const dealii::Mapping<dim> > ryujin::Discretization< dim >::mapping_
protected

Definition at line 336 of file discretization.h.

◆ finite_element_

template<int dim>
std::unique_ptr<const dealii::FiniteElement<dim> > ryujin::Discretization< dim >::finite_element_
protected

Definition at line 337 of file discretization.h.

◆ finite_element_cg_

template<int dim>
std::unique_ptr<const dealii::FiniteElement<dim> > ryujin::Discretization< dim >::finite_element_cg_
protected

Definition at line 338 of file discretization.h.

◆ quadrature_

template<int dim>
std::unique_ptr<const dealii::Quadrature<dim> > ryujin::Discretization< dim >::quadrature_
protected

Definition at line 339 of file discretization.h.

◆ nodal_quadrature_

template<int dim>
std::unique_ptr<const dealii::Quadrature<dim> > ryujin::Discretization< dim >::nodal_quadrature_
protected

Definition at line 340 of file discretization.h.

◆ quadrature_1d_

template<int dim>
std::unique_ptr<const dealii::Quadrature<1> > ryujin::Discretization< dim >::quadrature_1d_
protected

Definition at line 341 of file discretization.h.

◆ face_quadrature_

template<int dim>
std::unique_ptr<const dealii::Quadrature<dim - 1> > ryujin::Discretization< dim >::face_quadrature_
protected

Definition at line 342 of file discretization.h.

◆ face_nodal_quadrature_

template<int dim>
std::unique_ptr<const dealii::Quadrature<dim - 1> > ryujin::Discretization< dim >::face_nodal_quadrature_
protected

Definition at line 343 of file discretization.h.


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