PRISMS-PF Manual
Loading...
Searching...
No Matches
BoundaryParameters< dim > Struct Template Reference

Struct that holds boundary parameters. More...

#include <constraint_parameters.h>

Public Member Functions

void validate ()
 Postprocess and validate parameters.
 
void print_parameter_summary () const
 Print parameters to summary.log.
 
bool has_time_dependent_bcs () const
 Whether there are time-dependent boundary conditions.
 
void declare_parameters (dealii::ParameterHandler &parameter_handler, unsigned int max_criteria=5) const
 Declare the parameters to be read from an input file.
 
void assign_parameters (dealii::ParameterHandler &parameter_handler, unsigned int max_criteria=5)
 Assign the parameters read from an input file to this object.
 

Public Attributes

std::unordered_map< std::string, FieldConstraints< dim > > boundary_condition_list
 

Detailed Description

template<unsigned int dim>
struct BoundaryParameters< dim >

Struct that holds boundary parameters.

Member Function Documentation

◆ assign_parameters()

template<unsigned int dim>
void BoundaryParameters< dim >::assign_parameters ( dealii::ParameterHandler & parameter_handler,
unsigned int max_criteria = 5 )
inline

Assign the parameters read from an input file to this object.

◆ declare_parameters()

template<unsigned int dim>
void BoundaryParameters< dim >::declare_parameters ( dealii::ParameterHandler & parameter_handler,
unsigned int max_criteria = 5 ) const
inline

Declare the parameters to be read from an input file.

◆ has_time_dependent_bcs()

template<unsigned int dim>
bool BoundaryParameters< dim >::has_time_dependent_bcs ( ) const
inlinenodiscard

Whether there are time-dependent boundary conditions.

◆ print_parameter_summary()

template<unsigned int dim>
void BoundaryParameters< dim >::print_parameter_summary ( ) const
inline

Print parameters to summary.log.

◆ validate()

template<unsigned int dim>
void BoundaryParameters< dim >::validate ( )
inline

Postprocess and validate parameters.

Member Data Documentation

◆ boundary_condition_list

template<unsigned int dim>
std::unordered_map<std::string, FieldConstraints<dim> > BoundaryParameters< dim >::boundary_condition_list

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