Lethe Open-Source Library version 1.2.0
Developer Guide
Loading...
Searching...
No Matches
CLSLinearSubequationsSolver< dim > Class Template Referenceabstract

#include <cls_linear_subequations_solver.h>

Inheritance diagram for CLSLinearSubequationsSolver< dim >:
[legend]

Public Member Functions

 CLSLinearSubequationsSolver (const CLSSubequationsID &p_subequation_id, const SimulationParameters< dim > &p_simulation_parameters, const Parameters::Verbosity &p_subequation_verbosity, const ConditionalOStream &p_pcout, std::shared_ptr< parallel::DistributedTriangulationBase< dim > > p_triangulation, CLSSubequationsInterface< dim > &p_subequations_interface)
virtual ~CLSLinearSubequationsSolver ()=default
void setup_dofs () override
void solve () override
Public Member Functions inherited from PhysicsLinearSubequationsSolver
 PhysicsLinearSubequationsSolver (const ConditionalOStream &pcout)
virtual ~PhysicsLinearSubequationsSolver ()=default

Protected Member Functions

virtual void assemble_system_matrix_and_rhs ()=0
void solve_linear_system_and_update_solution () override
virtual void check_dependencies_validity ()=0

Protected Attributes

const CLSSubequationsID subequation_id
CLSSubequationsInterface< dim > & subequations_interface
const SimulationParameters< dim > & simulation_parameters
std::shared_ptr< parallel::DistributedTriangulationBase< dim > > triangulation
std::shared_ptr< DoFHandler< dim > > dof_handler
std::shared_ptr< FiniteElement< dim > > fe
std::shared_ptr< Mapping< dim > > mapping
std::shared_ptr< Quadrature< dim > > cell_quadrature
IndexSet locally_owned_dofs
IndexSet locally_relevant_dofs
GlobalVectorType evaluation_point
std::shared_ptr< GlobalVectorType > present_solution
GlobalVectorType system_rhs
AffineConstraints< double > constraints
TrilinosWrappers::SparseMatrix system_matrix
std::shared_ptr< TrilinosWrappers::PreconditionILU > ilu_preconditioner
const Parameters::Verbosity linear_solver_verbosity
const Parameters::Verbosity subequation_verbosity
Protected Attributes inherited from PhysicsLinearSubequationsSolver
const ConditionalOStream pcout

Detailed Description

template<int dim>
class CLSLinearSubequationsSolver< dim >

Generalized solver for CLS linear subequations.

Template Parameters
dimNumber of dimensions of the problem.

Definition at line 30 of file cls_linear_subequations_solver.h.

Constructor & Destructor Documentation

◆ CLSLinearSubequationsSolver()

template<int dim>
CLSLinearSubequationsSolver< dim >::CLSLinearSubequationsSolver ( const CLSSubequationsID & p_subequation_id,
const SimulationParameters< dim > & p_simulation_parameters,
const Parameters::Verbosity & p_subequation_verbosity,
const ConditionalOStream & p_pcout,
std::shared_ptr< parallel::DistributedTriangulationBase< dim > > p_triangulation,
CLSSubequationsInterface< dim > & p_subequations_interface )
inline

Constructor for linear subequations solvers within the CLS auxiliary physics.

Parameters
[in]p_subequation_idIdentifier corresponding to the subequation.
[in]p_simulation_parametersSimulation parameters.
[in]p_subequation_verbosityParameter indicating the verbosity level of the solver.
[in]p_pcoutParallel cout used to print the information.
[in]p_triangulationDistributed mesh information.
[in,out]p_subequations_interfaceSubequations interface object used to get information from other subequations and store information from the current one.

Definition at line 52 of file cls_linear_subequations_solver.h.

References CLS, dof_handler, linear_solver_verbosity, PhysicsLinearSubequationsSolver::PhysicsLinearSubequationsSolver(), present_solution, simulation_parameters, subequation_id, subequation_verbosity, subequations_interface, and triangulation.

◆ ~CLSLinearSubequationsSolver()

template<int dim>
virtual CLSLinearSubequationsSolver< dim >::~CLSLinearSubequationsSolver ( )
virtualdefault

Default destructor.

Member Function Documentation

◆ assemble_system_matrix_and_rhs()

template<int dim>
virtual void CLSLinearSubequationsSolver< dim >::assemble_system_matrix_and_rhs ( )
protectedpure virtual

Assemble the matrix and the right-hand side (rhs) associated with the solver.

Implemented in CLSCurvatureProjection< dim >, and CLSPhaseGradientProjection< dim >.

◆ check_dependencies_validity()

template<int dim>
virtual void CLSLinearSubequationsSolver< dim >::check_dependencies_validity ( )
protectedpure virtual

Check if the solutions on which the subequation depends on are valid.

Implemented in CLSCurvatureProjection< dim >, and CLSPhaseGradientProjection< dim >.

◆ setup_dofs()

◆ solve()

template<int dim>
void CLSLinearSubequationsSolver< dim >::solve ( )
overridevirtual

Assemble and solve linear system when the equation to solve is linear without using the non-linear solver interface.

Implements PhysicsSubequationsSolverBase.

Definition at line 196 of file cls_linear_subequations_solver.cc.

References assemble_system_matrix_and_rhs(), check_dependencies_validity(), solve_linear_system_and_update_solution(), subequation_id, and subequations_interface.

◆ solve_linear_system_and_update_solution()

template<int dim>
void CLSLinearSubequationsSolver< dim >::solve_linear_system_and_update_solution ( )
overrideprotectedvirtual

Member Data Documentation

◆ cell_quadrature

template<int dim>
std::shared_ptr<Quadrature<dim> > CLSLinearSubequationsSolver< dim >::cell_quadrature
protected

Definition at line 128 of file cls_linear_subequations_solver.h.

◆ constraints

template<int dim>
AffineConstraints<double> CLSLinearSubequationsSolver< dim >::constraints
protected

Definition at line 136 of file cls_linear_subequations_solver.h.

◆ dof_handler

template<int dim>
std::shared_ptr<DoFHandler<dim> > CLSLinearSubequationsSolver< dim >::dof_handler
protected

Definition at line 123 of file cls_linear_subequations_solver.h.

◆ evaluation_point

template<int dim>
GlobalVectorType CLSLinearSubequationsSolver< dim >::evaluation_point
protected

Definition at line 133 of file cls_linear_subequations_solver.h.

◆ fe

template<int dim>
std::shared_ptr<FiniteElement<dim> > CLSLinearSubequationsSolver< dim >::fe
protected

Definition at line 124 of file cls_linear_subequations_solver.h.

◆ ilu_preconditioner

template<int dim>
std::shared_ptr<TrilinosWrappers::PreconditionILU> CLSLinearSubequationsSolver< dim >::ilu_preconditioner
protected

Definition at line 138 of file cls_linear_subequations_solver.h.

◆ linear_solver_verbosity

template<int dim>
const Parameters::Verbosity CLSLinearSubequationsSolver< dim >::linear_solver_verbosity
protected

Definition at line 141 of file cls_linear_subequations_solver.h.

◆ locally_owned_dofs

template<int dim>
IndexSet CLSLinearSubequationsSolver< dim >::locally_owned_dofs
protected

Definition at line 131 of file cls_linear_subequations_solver.h.

◆ locally_relevant_dofs

template<int dim>
IndexSet CLSLinearSubequationsSolver< dim >::locally_relevant_dofs
protected

Definition at line 132 of file cls_linear_subequations_solver.h.

◆ mapping

template<int dim>
std::shared_ptr<Mapping<dim> > CLSLinearSubequationsSolver< dim >::mapping
protected

Definition at line 127 of file cls_linear_subequations_solver.h.

◆ present_solution

template<int dim>
std::shared_ptr<GlobalVectorType> CLSLinearSubequationsSolver< dim >::present_solution
protected

Definition at line 134 of file cls_linear_subequations_solver.h.

◆ simulation_parameters

template<int dim>
const SimulationParameters<dim>& CLSLinearSubequationsSolver< dim >::simulation_parameters
protected

Definition at line 119 of file cls_linear_subequations_solver.h.

◆ subequation_id

template<int dim>
const CLSSubequationsID CLSLinearSubequationsSolver< dim >::subequation_id
protected

Definition at line 115 of file cls_linear_subequations_solver.h.

◆ subequation_verbosity

template<int dim>
const Parameters::Verbosity CLSLinearSubequationsSolver< dim >::subequation_verbosity
protected

Definition at line 142 of file cls_linear_subequations_solver.h.

◆ subequations_interface

template<int dim>
CLSSubequationsInterface<dim>& CLSLinearSubequationsSolver< dim >::subequations_interface
protected

Definition at line 116 of file cls_linear_subequations_solver.h.

◆ system_matrix

template<int dim>
TrilinosWrappers::SparseMatrix CLSLinearSubequationsSolver< dim >::system_matrix
protected

Definition at line 137 of file cls_linear_subequations_solver.h.

◆ system_rhs

template<int dim>
GlobalVectorType CLSLinearSubequationsSolver< dim >::system_rhs
protected

Definition at line 135 of file cls_linear_subequations_solver.h.

◆ triangulation

template<int dim>
std::shared_ptr<parallel::DistributedTriangulationBase<dim> > CLSLinearSubequationsSolver< dim >::triangulation
protected

Definition at line 122 of file cls_linear_subequations_solver.h.


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