Lethe Open-Source Library version 1.2.0
Developer Guide
Loading...
Searching...
No Matches
PhysicsNonlinearSubequationsSolver< dim, VectorType > Class Template Reference

#include <physics_subequations_solver.h>

Inheritance diagram for PhysicsNonlinearSubequationsSolver< dim, VectorType >:
[legend]

Public Member Functions

 PhysicsNonlinearSubequationsSolver (const Parameters::NonLinearSolver non_linear_solver_parameters, const ConditionalOStream &pcout)
virtual ~PhysicsNonlinearSubequationsSolver ()=default
void setup_preconditioner () override
Public Member Functions inherited from PhysicsSubequationsSolverBase
virtual void setup_dofs ()=0
virtual void solve ()=0
Public Member Functions inherited from PhysicsSolver< VectorType >
 PhysicsSolver (const Parameters::NonLinearSolver non_linear_solver_parameters)
 PhysicsSolver ()
virtual ~PhysicsSolver ()
virtual void assemble_system_matrix ()=0
virtual void assemble_system_rhs ()=0
virtual void solve_linear_system ()=0
void solve_governing_system ()
virtual void apply_constraints ()
virtual VectorType & get_evaluation_point ()=0
virtual VectorType & get_local_evaluation_point ()=0
virtual VectorType & get_newton_update ()=0
virtual VectorType & get_present_solution ()=0
virtual VectorType & get_system_rhs ()=0
virtual AffineConstraints< double > & get_nonzero_constraints ()=0
virtual void output_newton_update_norms ()=0
virtual double get_residual_rescale_metric () const =0
virtual double get_current_residual ()
virtual bool allow_skip_linear_solve_when_residual_is_below_tolerance () const
unsigned int get_current_newton_iteration () const

Protected Attributes

const ConditionalOStream pcout

Additional Inherited Members

Public Attributes inherited from PhysicsSolver< VectorType >
ConditionalOStream pcout
Parameters::SimulationControl::TimeSteppingMethod time_stepping_method

Detailed Description

template<int dim, typename VectorType>
class PhysicsNonlinearSubequationsSolver< dim, VectorType >

Non-linear subequations solved inside a physics (or auxiliary physics) that are not part of the main set of equations.

Template Parameters
dimAn integer that denotes the dimension of the space in which the problem is solved.
VectorTypeThe Vector type used for the solvers.

Definition at line 77 of file physics_subequations_solver.h.

Constructor & Destructor Documentation

◆ PhysicsNonlinearSubequationsSolver()

template<int dim, typename VectorType>
PhysicsNonlinearSubequationsSolver< dim, VectorType >::PhysicsNonlinearSubequationsSolver ( const Parameters::NonLinearSolver non_linear_solver_parameters,
const ConditionalOStream & pcout )
inline

Constructor for physics subequations that require the use of a non-linear solver within the span of the physics solving.

Parameters
[in]non_linear_solver_parametersSet of parameters used to construct the non-linear solver.
[in]pcoutParallel cout used to print the information.

Definition at line 90 of file physics_subequations_solver.h.

References pcout, and PhysicsSolver< VectorType >::PhysicsSolver().

◆ ~PhysicsNonlinearSubequationsSolver()

template<int dim, typename VectorType>
virtual PhysicsNonlinearSubequationsSolver< dim, VectorType >::~PhysicsNonlinearSubequationsSolver ( )
virtualdefault

Default destructor.

Member Function Documentation

◆ setup_preconditioner()

template<int dim, typename VectorType>
void PhysicsNonlinearSubequationsSolver< dim, VectorType >::setup_preconditioner ( )
inlineoverridevirtual

Setup preconditioner.

Note
Not used for the physics subequations, but needed for the compilation of the non-linear solver.

Implements PhysicsSolver< VectorType >.

Definition at line 109 of file physics_subequations_solver.h.

Member Data Documentation

◆ pcout

template<int dim, typename VectorType>
const ConditionalOStream PhysicsNonlinearSubequationsSolver< dim, VectorType >::pcout
protected

Definition at line 112 of file physics_subequations_solver.h.


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