PRISMS-PF Manual
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
FieldInputParameters Struct Reference

Simple struct for field input. More...

#include <io_parameters.h>

Inheritance diagram for FieldInputParameters:
[legend]
Collaboration diagram for FieldInputParameters:
[legend]

Public Member Functions

void assign (dealii::ParameterHandler &parameter_handler, unsigned int n_subsections=Numbers::default_subsections) override
 Assign the parameters from file.
 
void validate (const std::vector< FieldAttributes > &field_attributes, const std::vector< SolveBlock > &solve_blocks) const override
 Validate.
 
- Public Member Functions inherited from ParameterBase
 ParameterBase ()=default
 
virtual ~ParameterBase ()=default
 
 ParameterBase (const ParameterBase &)=default
 
 ParameterBase (ParameterBase &&)=default
 
ParameterBase & operator= (const ParameterBase &)=default
 
ParameterBase & operator= (ParameterBase &&)=default
 

Static Public Member Functions

static void declare (dealii::ParameterHandler &parameter_handler, unsigned int n_subsections=Numbers::default_subsections)
 Declare the parameters to be read from file.
 

Public Attributes

bool load_from_file = false
 Whether to load initial conditions from file.
 
std::vector< InitialConditionFile > initial_condition_files
 

Detailed Description

Simple struct for field input.

Member Function Documentation

◆ assign()

void FieldInputParameters::assign ( dealii::ParameterHandler & parameter_handler,
unsigned int n_subsections = Numbers::default_subsections )
overridevirtual

Assign the parameters from file.

Implements ParameterBase.

◆ declare()

void FieldInputParameters::declare ( dealii::ParameterHandler & parameter_handler,
unsigned int n_subsections = Numbers::default_subsections )
static

Declare the parameters to be read from file.

◆ validate()

void FieldInputParameters::validate ( const std::vector< FieldAttributes > & field_attributes,
const std::vector< SolveBlock > & solve_blocks ) const
overridevirtual

Validate.

Implements ParameterBase.

Member Data Documentation

◆ initial_condition_files

std::vector<InitialConditionFile> FieldInputParameters::initial_condition_files

◆ load_from_file

bool FieldInputParameters::load_from_file = false

Whether to load initial conditions from file.

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