LinearSolverParameters Struct Reference

Struct that stores relevant linear solve information of a certain solve block. More...

#include <solve_parameters.h>

Inheritance diagram for LinearSolverParameters:

Collaboration diagram for LinearSolverParameters:

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.
void	assign_chebyshev (dealii::ParameterHandler &parameter_handler)
void	assign_richardson (dealii::ParameterHandler &parameter_handler)
void	assign_bicgstab (dealii::ParameterHandler &parameter_handler)
void	assign_gmres (dealii::ParameterHandler &parameter_handler)
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.
static void	declare_chebyshev (dealii::ParameterHandler &parameter_handler)
static void	declare_richardson (dealii::ParameterHandler &parameter_handler)
static void	declare_bicgstab (dealii::ParameterHandler &parameter_handler)
static void	declare_gmres (dealii::ParameterHandler &parameter_handler)

Public Attributes
std::string	solver_type = "cg"
double	tolerance = 1.0e-10
SolverToleranceType	tolerance_type = SolverToleranceType::RMSEPerField
unsigned int	max_iterations = 100
unsigned int	mg_depth = 1
PreconditionerType	preconditioner = PreconditionerType::None
dealii::PreconditionChebyshev ::AdditionalData	chebyshev_parameters
dealii::SolverRichardson ::AdditionalData	richardson_parameters
dealii::SolverBicgstab ::AdditionalData	bicgstab_parameters
dealii::SolverGMRES ::AdditionalData	gmres_parameters

Detailed Description

Struct that stores relevant linear solve information of a certain solve block.

Member Function Documentation

assign()

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

overridevirtual

Assign the parameters from file.

Implements ParameterBase.

assign_bicgstab()

void LinearSolverParameters::assign_bicgstab

(

dealii::ParameterHandler &

parameter_handler

)

assign_chebyshev()

void LinearSolverParameters::assign_chebyshev

(

dealii::ParameterHandler &

parameter_handler

)

assign_gmres()

void LinearSolverParameters::assign_gmres

(

dealii::ParameterHandler &

parameter_handler

)

assign_richardson()

void LinearSolverParameters::assign_richardson

(

dealii::ParameterHandler &

parameter_handler

)

declare()

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

static

Declare the parameters to be read from file.

declare_bicgstab()

void LinearSolverParameters::declare_bicgstab ( dealii::ParameterHandler & parameter_handler )

static

declare_chebyshev()

void LinearSolverParameters::declare_chebyshev ( dealii::ParameterHandler & parameter_handler )

static

declare_gmres()

void LinearSolverParameters::declare_gmres ( dealii::ParameterHandler & parameter_handler )

static

declare_richardson()

void LinearSolverParameters::declare_richardson ( dealii::ParameterHandler & parameter_handler )

static

validate()

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

overridevirtual

Validate.

Implements ParameterBase.

Member Data Documentation

bicgstab_parameters

dealii::SolverBicgstab ::AdditionalData LinearSolverParameters::bicgstab_parameters

chebyshev_parameters

dealii::PreconditionChebyshev ::AdditionalData LinearSolverParameters::chebyshev_parameters

gmres_parameters

dealii::SolverGMRES ::AdditionalData LinearSolverParameters::gmres_parameters

max_iterations

unsigned int LinearSolverParameters::max_iterations = 100

mg_depth

unsigned int LinearSolverParameters::mg_depth = 1

preconditioner

PreconditionerType LinearSolverParameters::preconditioner = PreconditionerType::None

richardson_parameters

dealii::SolverRichardson ::AdditionalData LinearSolverParameters::richardson_parameters

solver_type

std::string LinearSolverParameters::solver_type = "cg"

tolerance

double LinearSolverParameters::tolerance = 1.0e-10

tolerance_type

SolverToleranceType LinearSolverParameters::tolerance_type = SolverToleranceType::RMSEPerField

---

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

• /__w/phaseField/phaseField/include/prismspf/user_inputs/solve_parameters.h
• /__w/phaseField/phaseField/src/user_inputs/solve_parameters.cc