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

#include <cls_pde_based_interface_reinitialization.h>

Inheritance diagram for CLSPDEBasedInterfaceReinitialization< dim >:
[legend]

Public Member Functions

 CLSPDEBasedInterfaceReinitialization (const SimulationParameters< dim > &p_simulation_parameters, const ConditionalOStream &p_pcout, std::shared_ptr< parallel::DistributedTriangulationBase< dim > > p_triangulation, const std::shared_ptr< SimulationControl > &p_simulation_control, CLSSubequationsInterface< dim > &p_subequations_interface)
 ~CLSPDEBasedInterfaceReinitialization ()=default
void setup_dofs () override
void solve () override
GlobalVectorType & get_evaluation_point () override
GlobalVectorType & get_local_evaluation_point () override
GlobalVectorType & get_newton_update () override
GlobalVectorType & get_present_solution () override
GlobalVectorType & get_system_rhs () override
AffineConstraints< double > & get_nonzero_constraints () override
void output_newton_update_norms () override
double get_residual_rescale_metric () const override
Public Member Functions inherited from PhysicsNonlinearSubequationsSolver< dim, GlobalVectorType >
 PhysicsNonlinearSubequationsSolver (const Parameters::NonLinearSolver non_linear_solver_parameters, const ConditionalOStream &pcout)
virtual ~PhysicsNonlinearSubequationsSolver ()=default
void setup_preconditioner () override
Public Member Functions inherited from PhysicsSolver< GlobalVectorType >
 PhysicsSolver (const Parameters::NonLinearSolver non_linear_solver_parameters)
virtual ~PhysicsSolver ()
void solve_governing_system ()
virtual void apply_constraints ()
virtual double get_current_residual ()
virtual bool allow_skip_linear_solve_when_residual_is_below_tolerance () const
unsigned int get_current_newton_iteration () const

Private Member Functions

void write_output_results (const unsigned int step)
double compute_diffusivity (const double min_cell_size) const
double compute_time_step ()
void define_zero_constraints ()
void define_non_zero_constraints ()
void set_initial_conditions ()
void assemble_system_matrix () override
void assemble_system_rhs () override
void solve_linear_system () override
bool continue_iterating (const unsigned int step_number)
void check_dependencies_validity ()

Private Attributes

const CLSSubequationsID subequation_id
CLSSubequationsInterface< dim > & subequations_interface
const SimulationParameters< dim > & simulation_parameters
std::shared_ptr< SimulationControl > simulation_control
PVDHandler pvdhandler
double current_time_step
std::vector< double > time_step_vector = {0.0}
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
GlobalVectorType local_evaluation_point
GlobalVectorType previous_local_evaluation_point
GlobalVectorType newton_update
std::shared_ptr< GlobalVectorType > present_solution
GlobalVectorType previous_solution
GlobalVectorType system_rhs
AffineConstraints< double > zero_constraints
AffineConstraints< double > nonzero_constraints
TrilinosWrappers::SparseMatrix system_matrix
const Parameters::Verbosity subequation_verbosity

Additional Inherited Members

Public Attributes inherited from PhysicsSolver< GlobalVectorType >
ConditionalOStream pcout
Parameters::SimulationControl::TimeSteppingMethod time_stepping_method
Protected Attributes inherited from PhysicsNonlinearSubequationsSolver< dim, GlobalVectorType >
const ConditionalOStream pcout

Detailed Description

template<int dim>
class CLSPDEBasedInterfaceReinitialization< dim >

CLS PDE-based reinitialization solver.

Template Parameters
dimNumber of dimensions of the problem.

Definition at line 35 of file cls_pde_based_interface_reinitialization.h.

Constructor & Destructor Documentation

◆ CLSPDEBasedInterfaceReinitialization()

template<int dim>
CLSPDEBasedInterfaceReinitialization< dim >::CLSPDEBasedInterfaceReinitialization ( const SimulationParameters< dim > & p_simulation_parameters,
const ConditionalOStream & p_pcout,
std::shared_ptr< parallel::DistributedTriangulationBase< dim > > p_triangulation,
const std::shared_ptr< SimulationControl > & p_simulation_control,
CLSSubequationsInterface< dim > & p_subequations_interface )
inline

Constructor of the CLS PDE-based interface reinitialization.

Parameters
[in]p_simulation_parametersSimulation parameters.
[in]p_pcoutParallel cout used to print the information.
[in]p_triangulationDistributed mesh information.
[in]p_simulation_controlSimulationControl object.
[in,out]p_subequations_interfaceSubequations interface object used to get information from other subequations and store information from the current one.

Definition at line 54 of file cls_pde_based_interface_reinitialization.h.

References cell_quadrature, dof_handler, fe, mapping, PhysicsNonlinearSubequationsSolver< dim, GlobalVectorType >::pcout, PhysicsNonlinearSubequationsSolver< dim, GlobalVectorType >::PhysicsNonlinearSubequationsSolver(), present_solution, simulation_control, simulation_parameters, subequation_id, subequation_verbosity, subequations_interface, and triangulation.

◆ ~CLSPDEBasedInterfaceReinitialization()

Default destructor.

Member Function Documentation

◆ assemble_system_matrix()

◆ assemble_system_rhs()

◆ check_dependencies_validity()

template<int dim>
void CLSPDEBasedInterfaceReinitialization< dim >::check_dependencies_validity ( )
private

Check if the phase gradient and curvature L2 projections have been solved.

Definition at line 780 of file cls_pde_based_interface_reinitialization.cc.

References phase_gradient_projection, and subequations_interface.

◆ compute_diffusivity()

template<int dim>
double CLSPDEBasedInterfaceReinitialization< dim >::compute_diffusivity ( const double min_cell_size) const
inlineprivate

Computes mesh-dependant diffusivity coefficient value.

Parameters
[in]min_cell_sizeSmallest cell's measure.
Returns
Constant diffusivity coefficient value for a given mesh.

Definition at line 245 of file cls_pde_based_interface_reinitialization.h.

References simulation_parameters.

◆ compute_time_step()

template<int dim>
double CLSPDEBasedInterfaceReinitialization< dim >::compute_time_step ( )
inlineprivate

Computes PDE-based reinitialization time step value with user-imposed CFL and minimum cell size.

Returns
PDE-based reinitialization time step.

Definition at line 265 of file cls_pde_based_interface_reinitialization.h.

References cell_quadrature, compute_diffusivity(), dof_handler, identify_minimum_cell_size(), mapping, simulation_control, simulation_parameters, and triangulation.

◆ continue_iterating()

template<int dim>
bool CLSPDEBasedInterfaceReinitialization< dim >::continue_iterating ( const unsigned int step_number)
inlineprivate

Indicate if the PDE-based reinitialization should continue by checking if at least one of the two stop criteria (steady-state criterion or maximum number of reinitialization steps) is met.

Parameters
[in]step_numberPDE-based interface reinitialization step number.
Returns
Boolean indicating if the PDE-based reinitialization should continue

Definition at line 338 of file cls_pde_based_interface_reinitialization.h.

References Parameters::extra_verbose, local_evaluation_point, PhysicsNonlinearSubequationsSolver< dim, GlobalVectorType >::pcout, previous_local_evaluation_point, simulation_parameters, and subequation_verbosity.

◆ define_non_zero_constraints()

template<int dim>
void CLSPDEBasedInterfaceReinitialization< dim >::define_non_zero_constraints ( )
private

◆ define_zero_constraints()

template<int dim>
void CLSPDEBasedInterfaceReinitialization< dim >::define_zero_constraints ( )
private

◆ get_evaluation_point()

template<int dim>
GlobalVectorType & CLSPDEBasedInterfaceReinitialization< dim >::get_evaluation_point ( )
inlineoverridevirtual

Getter method to access the private attribute evaluation_point for the subequation currently solved.

Returns
The vector in which the evaluation is performed.

Implements PhysicsSolver< GlobalVectorType >.

Definition at line 126 of file cls_pde_based_interface_reinitialization.h.

References evaluation_point.

◆ get_local_evaluation_point()

template<int dim>
GlobalVectorType & CLSPDEBasedInterfaceReinitialization< dim >::get_local_evaluation_point ( )
inlineoverridevirtual

Getter method to access the private attribute local_evaluation_point for the subequation currently solved.

Returns
The local evaluation point. Ghosts cells are not considered in this evaluation.

Implements PhysicsSolver< GlobalVectorType >.

Definition at line 139 of file cls_pde_based_interface_reinitialization.h.

References local_evaluation_point.

◆ get_newton_update()

template<int dim>
GlobalVectorType & CLSPDEBasedInterfaceReinitialization< dim >::get_newton_update ( )
inlineoverridevirtual

Getter method to access the private attribute newton_update for the subequation currently solved.

Returns
The direction used to perform the newton iteration.

Implements PhysicsSolver< GlobalVectorType >.

Definition at line 151 of file cls_pde_based_interface_reinitialization.h.

References newton_update.

◆ get_nonzero_constraints()

template<int dim>
AffineConstraints< double > & CLSPDEBasedInterfaceReinitialization< dim >::get_nonzero_constraints ( )
inlineoverridevirtual

Getter method to access the private attribute nonzero_constraints for the subequation currently solved.

Returns
Container of nonzero constraints that arise from several sources such as boundary conditions and hanging nodes in the mesh. See the deal.II documentation on constraints on degrees of freedom for more information.

Implements PhysicsSolver< GlobalVectorType >.

Definition at line 189 of file cls_pde_based_interface_reinitialization.h.

References nonzero_constraints.

◆ get_present_solution()

template<int dim>
GlobalVectorType & CLSPDEBasedInterfaceReinitialization< dim >::get_present_solution ( )
inlineoverridevirtual

Getter method to access the private attribute present_solution for the subequation currently solved.

Returns
Vector containing all the values of the solution.

Implements PhysicsSolver< GlobalVectorType >.

Definition at line 163 of file cls_pde_based_interface_reinitialization.h.

References present_solution.

◆ get_residual_rescale_metric()

template<int dim>
double CLSPDEBasedInterfaceReinitialization< dim >::get_residual_rescale_metric ( ) const
inlineoverridevirtual

Return the metric for residual rescaling. By default, should return 1. If the rescale_residual_by_volume is set to true, the method returns the square root of the global volume of the triangulation.

Returns
Rescale metric.

Implements PhysicsSolver< GlobalVectorType >.

Definition at line 215 of file cls_pde_based_interface_reinitialization.h.

References CLS, mapping, simulation_parameters, and triangulation.

◆ get_system_rhs()

template<int dim>
GlobalVectorType & CLSPDEBasedInterfaceReinitialization< dim >::get_system_rhs ( )
inlineoverridevirtual

Getter method to access the private attribute system_rhs for the subequation currently solved.

Returns
Right-hand side vector.

Implements PhysicsSolver< GlobalVectorType >.

Definition at line 175 of file cls_pde_based_interface_reinitialization.h.

References system_rhs.

◆ output_newton_update_norms()

template<int dim>
void CLSPDEBasedInterfaceReinitialization< dim >::output_newton_update_norms ( )
inlineoverridevirtual

Output the \(L_2\) and \(L_\infty\) norms of the correction vector.

Implements PhysicsSolver< GlobalVectorType >.

Definition at line 199 of file cls_pde_based_interface_reinitialization.h.

References newton_update, and PhysicsNonlinearSubequationsSolver< dim, GlobalVectorType >::pcout.

◆ set_initial_conditions()

template<int dim>
void CLSPDEBasedInterfaceReinitialization< dim >::set_initial_conditions ( )
private

◆ setup_dofs()

◆ solve()

◆ solve_linear_system()

◆ write_output_results()

template<int dim>
void CLSPDEBasedInterfaceReinitialization< dim >::write_output_results ( const unsigned int step)
private

Write parallel VTU files of quantities of interest for the PDE-based interface reinitialization process.

Parameters
[in]stepInteger indicating the reinitialization step number.
Note
Only the reinitialization steps of the last global time step (simulation time step) ran are outputted.

Definition at line 722 of file cls_pde_based_interface_reinitialization.cc.

References dof_handler, mapping, phase_gradient_projection, present_solution, pvdhandler, simulation_control, simulation_parameters, subequations_interface, triangulation, and write_vtu_and_pvd().

Member Data Documentation

◆ cell_quadrature

template<int dim>
std::shared_ptr<Quadrature<dim> > CLSPDEBasedInterfaceReinitialization< dim >::cell_quadrature
private

Definition at line 417 of file cls_pde_based_interface_reinitialization.h.

◆ current_time_step

template<int dim>
double CLSPDEBasedInterfaceReinitialization< dim >::current_time_step
private

Definition at line 407 of file cls_pde_based_interface_reinitialization.h.

◆ dof_handler

template<int dim>
std::shared_ptr<DoFHandler<dim> > CLSPDEBasedInterfaceReinitialization< dim >::dof_handler
private

Definition at line 412 of file cls_pde_based_interface_reinitialization.h.

◆ evaluation_point

template<int dim>
GlobalVectorType CLSPDEBasedInterfaceReinitialization< dim >::evaluation_point
private

Definition at line 422 of file cls_pde_based_interface_reinitialization.h.

◆ fe

template<int dim>
std::shared_ptr<FiniteElement<dim> > CLSPDEBasedInterfaceReinitialization< dim >::fe
private

Definition at line 413 of file cls_pde_based_interface_reinitialization.h.

◆ local_evaluation_point

template<int dim>
GlobalVectorType CLSPDEBasedInterfaceReinitialization< dim >::local_evaluation_point
private

Definition at line 423 of file cls_pde_based_interface_reinitialization.h.

◆ locally_owned_dofs

template<int dim>
IndexSet CLSPDEBasedInterfaceReinitialization< dim >::locally_owned_dofs
private

Definition at line 420 of file cls_pde_based_interface_reinitialization.h.

◆ locally_relevant_dofs

template<int dim>
IndexSet CLSPDEBasedInterfaceReinitialization< dim >::locally_relevant_dofs
private

Definition at line 421 of file cls_pde_based_interface_reinitialization.h.

◆ mapping

template<int dim>
std::shared_ptr<Mapping<dim> > CLSPDEBasedInterfaceReinitialization< dim >::mapping
private

Definition at line 416 of file cls_pde_based_interface_reinitialization.h.

◆ newton_update

template<int dim>
GlobalVectorType CLSPDEBasedInterfaceReinitialization< dim >::newton_update
private

Definition at line 425 of file cls_pde_based_interface_reinitialization.h.

◆ nonzero_constraints

template<int dim>
AffineConstraints<double> CLSPDEBasedInterfaceReinitialization< dim >::nonzero_constraints
private

Definition at line 430 of file cls_pde_based_interface_reinitialization.h.

◆ present_solution

template<int dim>
std::shared_ptr<GlobalVectorType> CLSPDEBasedInterfaceReinitialization< dim >::present_solution
private

Definition at line 426 of file cls_pde_based_interface_reinitialization.h.

◆ previous_local_evaluation_point

template<int dim>
GlobalVectorType CLSPDEBasedInterfaceReinitialization< dim >::previous_local_evaluation_point
private

Definition at line 424 of file cls_pde_based_interface_reinitialization.h.

◆ previous_solution

template<int dim>
GlobalVectorType CLSPDEBasedInterfaceReinitialization< dim >::previous_solution
private

Definition at line 427 of file cls_pde_based_interface_reinitialization.h.

◆ pvdhandler

template<int dim>
PVDHandler CLSPDEBasedInterfaceReinitialization< dim >::pvdhandler
private

Definition at line 404 of file cls_pde_based_interface_reinitialization.h.

◆ simulation_control

template<int dim>
std::shared_ptr<SimulationControl> CLSPDEBasedInterfaceReinitialization< dim >::simulation_control
private

Definition at line 401 of file cls_pde_based_interface_reinitialization.h.

◆ simulation_parameters

template<int dim>
const SimulationParameters<dim>& CLSPDEBasedInterfaceReinitialization< dim >::simulation_parameters
private

Definition at line 398 of file cls_pde_based_interface_reinitialization.h.

◆ subequation_id

template<int dim>
const CLSSubequationsID CLSPDEBasedInterfaceReinitialization< dim >::subequation_id
private

Definition at line 394 of file cls_pde_based_interface_reinitialization.h.

◆ subequation_verbosity

template<int dim>
const Parameters::Verbosity CLSPDEBasedInterfaceReinitialization< dim >::subequation_verbosity
private

Definition at line 434 of file cls_pde_based_interface_reinitialization.h.

◆ subequations_interface

template<int dim>
CLSSubequationsInterface<dim>& CLSPDEBasedInterfaceReinitialization< dim >::subequations_interface
private

Definition at line 395 of file cls_pde_based_interface_reinitialization.h.

◆ system_matrix

template<int dim>
TrilinosWrappers::SparseMatrix CLSPDEBasedInterfaceReinitialization< dim >::system_matrix
private

Definition at line 431 of file cls_pde_based_interface_reinitialization.h.

◆ system_rhs

template<int dim>
GlobalVectorType CLSPDEBasedInterfaceReinitialization< dim >::system_rhs
private

Definition at line 428 of file cls_pde_based_interface_reinitialization.h.

◆ time_step_vector

template<int dim>
std::vector<double> CLSPDEBasedInterfaceReinitialization< dim >::time_step_vector = {0.0}
private

Definition at line 408 of file cls_pde_based_interface_reinitialization.h.

◆ triangulation

template<int dim>
std::shared_ptr<parallel::DistributedTriangulationBase<dim> > CLSPDEBasedInterfaceReinitialization< dim >::triangulation
private

Definition at line 411 of file cls_pde_based_interface_reinitialization.h.

◆ zero_constraints

template<int dim>
AffineConstraints<double> CLSPDEBasedInterfaceReinitialization< dim >::zero_constraints
private

Definition at line 429 of file cls_pde_based_interface_reinitialization.h.


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