https://mooseframework.inl.gov
Public Member Functions | Public Attributes | List of all members
MooseApp::FixedPointConfig Struct Reference

Stores configuration options relating to the fixed-point solving capability. More...

#include <MooseApp.h>

Public Member Functions

 FixedPointConfig ()
 

Public Attributes

Real sub_relaxation_factor
 relaxation factor to be used for a MultiApp's subapps. More...
 
std::vector< std::string > sub_transformed_vars
 The names of variables to transform for fixed point solve algorithms (e.g. secant, etc.). More...
 
std::vector< PostprocessorName > sub_transformed_pps
 The names of postprocessors to transform for fixed point solve algorithms (e.g. secant, etc.). More...
 

Detailed Description

Stores configuration options relating to the fixed-point solving capability.

This is used for communicating input-file-based config from the MultiApp object/syntax to the execution (e.g. executor) system.

Definition at line 101 of file MooseApp.h.

Constructor & Destructor Documentation

◆ FixedPointConfig()

MooseApp::FixedPointConfig::FixedPointConfig ( )
inline

Definition at line 103 of file MooseApp.h.

103 : sub_relaxation_factor(1.0) {}
Real sub_relaxation_factor
relaxation factor to be used for a MultiApp&#39;s subapps.
Definition: MooseApp.h:105

Member Data Documentation

◆ sub_relaxation_factor

Real MooseApp::FixedPointConfig::sub_relaxation_factor

relaxation factor to be used for a MultiApp's subapps.

Definition at line 105 of file MooseApp.h.

Referenced by FixedPointSolve::FixedPointSolve().

◆ sub_transformed_pps

std::vector<PostprocessorName> MooseApp::FixedPointConfig::sub_transformed_pps

The names of postprocessors to transform for fixed point solve algorithms (e.g. secant, etc.).

Definition at line 109 of file MooseApp.h.

Referenced by FixedPointSolve::FixedPointSolve().

◆ sub_transformed_vars

std::vector<std::string> MooseApp::FixedPointConfig::sub_transformed_vars

The names of variables to transform for fixed point solve algorithms (e.g. secant, etc.).

Definition at line 107 of file MooseApp.h.

Referenced by FixedPointSolve::FixedPointSolve().


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