Sapphire++
 v1.3.0-121-g2682132
Loading...
Searching...
No Matches
sapphirepp::PhysicalParameters Class Reference

Class to implement user defined parameters. More...

#include <config.h>

Public Member Functions

 PhysicalParameters ()=default
void declare_parameters (dealii::ParameterHandler &prm)
 Declare parameters in parameter file.
void parse_parameters (dealii::ParameterHandler &prm)
 Parse parameters from parameter file.

Detailed Description

Class to implement user defined parameters.

Constructor & Destructor Documentation

◆ PhysicalParameters()

sapphirepp::PhysicalParameters::PhysicalParameters ( )
default

[Define runtime parameter] [Define runtime parameter] Constructor

Member Function Documentation

◆ declare_parameters()

void sapphirepp::PhysicalParameters::declare_parameters ( dealii::ParameterHandler & prm)
inline

Declare parameters in parameter file.

Parameters
prmParameterHandler

Runtime parameters can be either added using the prm.add_parameter() function, or declared using prm.declare_entry(). If the parameters are only declared instead of added, they have to be parsed in the parse_parameters() function below.

[Declare runtime parameter]

[Declare runtime parameter]

◆ parse_parameters()

void sapphirepp::PhysicalParameters::parse_parameters ( dealii::ParameterHandler & prm)
inline

Parse parameters from parameter file.

Parameters
prmParameterHandler

[Parse runtime parameter]

[Parse runtime parameter]


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