FieldOutputParameterLoader Class Reference

A class that determines how often and what fields are output. More...

#include <io_parameters.h>

Inheritance diagram for FieldOutputParameterLoader:

Collaboration diagram for FieldOutputParameterLoader:

Public Member Functions
void	declare (dealii::ParameterHandler &parameter_handler) const override
	Declare parameters.
void	read (dealii::ParameterHandler &parameter_handler) override
	Read parameters.
void	postprocess (unsigned int n_increments)
	Postprocess parameters.
void	validate (const std::vector< VariableAttributes > &field_attributes) const override
	Validate parameters.
FieldOutputParameters	package () const
	Package parameters.
void	print_parameter_summary () const override
	Print parameters to summary.log.

Private Member Functions
void	fill_out_output_list (unsigned int n_increments)

Private Attributes
FieldOutputParameters	parameters
std::string	condition
std::vector< int >	user_output_list
unsigned int	n_outputs = 0
std::vector< std::string >	field_list

Detailed Description

A class that determines how often and what fields are output.

Member Function Documentation

declare()

void FieldOutputParameterLoader::declare ( dealii::ParameterHandler &  parameter_handler ) const

inlineoverride

Declare parameters.

fill_out_output_list()

void FieldOutputParameterLoader::fill_out_output_list ( unsigned int  n_increments )

inlineprivate

package()

FieldOutputParameters FieldOutputParameterLoader::package ( ) const

inline

Package parameters.

postprocess()

void FieldOutputParameterLoader::postprocess ( unsigned int  n_increments )

inline

Postprocess parameters.

print_parameter_summary()

void FieldOutputParameterLoader::print_parameter_summary ( ) const

inlineoverride

Print parameters to summary.log.

read()

void FieldOutputParameterLoader::read ( dealii::ParameterHandler &  parameter_handler )

inlineoverride

Read parameters.

validate()

void FieldOutputParameterLoader::validate ( const std::vector< VariableAttributes > &  field_attributes ) const

inlineoverride

Validate parameters.

Member Data Documentation

condition

std::string FieldOutputParameterLoader::condition

private

field_list

std::vector<std::string> FieldOutputParameterLoader::field_list

private

n_outputs

unsigned int FieldOutputParameterLoader::n_outputs = 0

private

parameters

FieldOutputParameters FieldOutputParameterLoader::parameters

private

user_output_list

std::vector<int> FieldOutputParameterLoader::user_output_list

private

---

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

• /home/runner/work/phaseField/phaseField/include/prismspf/user_inputs/io_parameters.h