ryujin::Interface::ParabolicSystem Class Reference

#include <include/ryujin/interface/parabolic_system.h>

Inheritance diagram for ryujin::Interface::ParabolicSystem:

Collaboration diagram for ryujin::Interface::ParabolicSystem:

Public Types
using	Names = std::array< std::vector< std::string >, 3 >

Public Member Functions
const std::vector< std::string > &	state_names (const unsigned int dim) const
const std::vector< std::string > &	precomputed_names (const unsigned int dim) const

Protected Member Functions
	ParabolicSystem (const std::string &problem_name, const Names &state_names, const Names &precomputed_names, const std::string &subsection)

Protected Attributes
std::string	problem_name_
Names	state_names_
Names	precomputed_names_
bool	is_identity_

Detailed Description

The description-free part of a parabolic system: its name and the names of its components.

All components of a parabolic system are dynamic: they are stored as scalar vectors in StateVector::dynamic_state and StateVector::dynamic_precomputed.

Definition at line 32 of file parabolic_system.h.

Member Typedef Documentation

Names

using ryujin::Interface::ParabolicSystem::Names = std::array<std::vector<std::string>, 3>

The name of the system as a string. A list of component names for every dimension:

Definition at line 43 of file parabolic_system.h.

Constructor & Destructor Documentation

ParabolicSystem()

ryujin::Interface::ParabolicSystem::ParabolicSystem ( const std::string &  problem_name, const Names &  state_names, const Names &  precomputed_names, const std::string &  subsection  )

inlineprotected

Whether the parabolic system is the identity, i.e., whether the equation is purely hyperbolic. Constructor.

Definition at line 78 of file parabolic_system.h.

Member Function Documentation

state_names()

const std::vector< std::string > & ryujin::Interface::ParabolicSystem::state_names ( const unsigned int  dim ) const

inline

The names of the state components for dimension dim.

Note

Valid once the run time parameters are parsed.

Definition at line 50 of file parabolic_system.h.

References state_names_.

precomputed_names()

const std::vector< std::string > & ryujin::Interface::ParabolicSystem::precomputed_names ( const unsigned int  dim ) const

inline

The names of the precomputed values for dimension dim.

Note

Valid once the run time parameters are parsed.

Definition at line 62 of file parabolic_system.h.

References precomputed_names_.

Member Data Documentation

problem_name_

std::string ryujin::Interface::ParabolicSystem::problem_name_

protected

The name of the system.

Note

A derived class may update it once the run time parameters are known.

Definition at line 96 of file parabolic_system.h.

state_names_

Names ryujin::Interface::ParabolicSystem::state_names_

protected

The names of the state components for every dimension.

Note

A derived class may update them once the run time parameters are known.

Definition at line 104 of file parabolic_system.h.

Referenced by state_names().

precomputed_names_

Names ryujin::Interface::ParabolicSystem::precomputed_names_

protected

The names of the precomputed values for every dimension.

Note

A derived class may update them once the run time parameters are known.

Definition at line 112 of file parabolic_system.h.

Referenced by precomputed_names().

is_identity_

bool ryujin::Interface::ParabolicSystem::is_identity_

protected

Whether the parabolic system is the identity.

Note

A derived class that models the identity sets it in its constructor.

Definition at line 120 of file parabolic_system.h.

---

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

• include/ryujin/interface/parabolic_system.h