ryujin::Interface::System Class Reference

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

Inheritance diagram for ryujin::Interface::System:

Collaboration diagram for ryujin::Interface::System:

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
	System (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_

Detailed Description

The common description-free part of a hyperbolic and a parabolic system: its name and the names of the components it contributes to a state vector.

State components are evolved by the time integrator: they take part in sadd(), in the solution transfer, and in a checkpoint.

Precomputed values are derived from the state and recomputed whenever the state changes.

Definition at line 35 of file system.h.

Member Typedef Documentation

Names

using ryujin::Interface::System::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 46 of file system.h.

Constructor & Destructor Documentation

System()

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

inlineprotected

Constructor.

Definition at line 75 of file system.h.

Member Function Documentation

state_names()

const std::vector< std::string > & ryujin::Interface::System::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 53 of file system.h.

References state_names_.

precomputed_names()

const std::vector< std::string > & ryujin::Interface::System::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 65 of file system.h.

References precomputed_names_.

Member Data Documentation

problem_name_

std::string ryujin::Interface::System::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 92 of file system.h.

state_names_

Names ryujin::Interface::System::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 100 of file system.h.

Referenced by state_names().

precomputed_names_

Names ryujin::Interface::System::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 108 of file system.h.

Referenced by precomputed_names().

---

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

• include/ryujin/interface/system.h