![]() |
Lethe Open-Source Library version 1.2.0
Developer Guide
|
#include <auxiliary_physics.h>
Additional Inherited Members | |
| Public Attributes inherited from PhysicsSolver< VectorType > | |
| ConditionalOStream | pcout |
| Parameters::SimulationControl::TimeSteppingMethod | time_stepping_method |
Au auxiliary physics is defined as a physics that is solved on top of a core physics, the latter being the Navier-Stokes equations. Auxiliary physics are simpler physics around which the entire simulation process does not need to be tailored. Examples of auxiliary physics are temperature and concentration. Generally, the auxiliary physics does not affect the core physics. For example, temperature is advected by the fluid flow, but buoyancy effects are not taken into account.
The auxiliary physics are managed by the multiphysics interface of Lethe.
This base class is used to establish all of the routines that an auxiliary physics must be able to provide to the Multiphysics interface. These elements are then called at specific moments of a simulation.
Auxiliary physics are templated by the dimension of the problem and the vector type that is used to manage their data.
Current limitations:
Definition at line 44 of file auxiliary_physics.h.
|
inline |
AuxiliaryPhysics - Base constructor for Auxiliary physics. This constructor builds an auxiliary physics which solves a non-linear problem. Consequently, the auxiliary physics must assemble its right-hand-side and matrix in the residual form. This means that the solution is reached when |R(u)|=0 where R is the residual vector and u the solution.
| [in] | non_linear_solver_parameters | Parameters for the non-linear solvers that drives the solution of the non-linear physics. |
Definition at line 58 of file auxiliary_physics.h.
References PhysicsSolver< VectorType >::PhysicsSolver().
|
inline |
AuxiliaryPhysics - Base constructor for Auxiliary physics. This constructor builds an auxiliary physics which solves a linear problem. Consequently, the auxiliary physics must assemble its right-hand-side and matrix in the form Au=b.
Definition at line 69 of file auxiliary_physics.h.
References PhysicsSolver< VectorType >::PhysicsSolver().
|
virtualdefault |
AuxiliaryPhysics - Base destructor. At the present moment this is an interface with nothing.
|
pure virtual |
Compute the Kelly error estimator used to refine mesh on a auxiliary physic parameter.
| [in] | ivar | The current element of the map simulation_parameters.mesh_adaptation.variables |
| [in,out] | estimated_error_per_cell | The deal.II vector of estimated_error_per_cell |
Implemented in CahnHilliard< dim >, ConservativeLevelSet< dim >, ContinuumSolidDynamics< dim >, HeatTransfer< dim >, TimeHarmonicMaxwell< dim >, and Tracer< dim >.
|
pure virtual |
Carry out the operations required to finish a simulation correctly.
Implemented in CahnHilliard< dim >, ConservativeLevelSet< dim >, ContinuumSolidDynamics< dim >, HeatTransfer< dim >, TimeHarmonicMaxwell< dim >, and Tracer< dim >.
|
inlinevirtual |
Gather and return vector of output structs that are particular to some applications.
Reimplemented in CahnHilliard< dim >, ConservativeLevelSet< dim >, ContinuumSolidDynamics< dim >, HeatTransfer< dim >, TimeHarmonicMaxwell< dim >, and Tracer< dim >.
Definition at line 85 of file auxiliary_physics.h.
|
pure virtual |
Returns a vector of references to TableHandler objects that needs to be serialized/deserialized for a given AuxiliaryPhysics solver.
Implemented in CahnHilliard< dim >, ConservativeLevelSet< dim >, ContinuumSolidDynamics< dim >, HeatTransfer< dim >, TimeHarmonicMaxwell< dim >, and Tracer< dim >.
|
pure virtual |
Provide the dof handler associated with an auxiliary physics TODO : delete as the auxiliary physics are supposed to pass their dof_handler to the multiphysics_interface directly.
Implemented in CahnHilliard< dim >, ConservativeLevelSet< dim >, ContinuumSolidDynamics< dim >, HeatTransfer< dim >, TimeHarmonicMaxwell< dim >, and Tracer< dim >.
|
inlinevirtual |
Carry out modifications on the auxiliary physic solution. To be defined for some physics only (eg. free surface, see cls.h).
Reimplemented in CahnHilliard< dim >, ConservativeLevelSet< dim >, TimeHarmonicMaxwell< dim >, and Tracer< dim >.
Definition at line 108 of file auxiliary_physics.h.
|
pure virtual |
Output the per iteration wallclock times.
Implemented in CahnHilliard< dim >, ConservativeLevelSet< dim >, ContinuumSolidDynamics< dim >, HeatTransfer< dim >, TimeHarmonicMaxwell< dim >, and Tracer< dim >.
|
pure virtual |
Carry out the operations required to rearrange the values of the previous solution at the end of a time step.
Implemented in CahnHilliard< dim >, ConservativeLevelSet< dim >, ContinuumSolidDynamics< dim >, HeatTransfer< dim >, TimeHarmonicMaxwell< dim >, and Tracer< dim >.
|
pure virtual |
post_mesh_adaption Interpolates the auxiliary physics variables to the new mesh
Implemented in CahnHilliard< dim >, ConservativeLevelSet< dim >, ContinuumSolidDynamics< dim >, HeatTransfer< dim >, TimeHarmonicMaxwell< dim >, and Tracer< dim >.
|
pure virtual |
Postprocess the auxiliary physics results. Post-processing this case implies the calculation of all derived quantities using the solution vector of the physics. It does not concern the output of the solution using the DataOutObject, which is accomplished through the attach_solution_to_output function.
Implemented in CahnHilliard< dim >, ConservativeLevelSet< dim >, ContinuumSolidDynamics< dim >, HeatTransfer< dim >, TimeHarmonicMaxwell< dim >, and Tracer< dim >.
|
pure virtual |
pre_mesh_adaption Prepares the auxiliary physics variables for a mesh refinement/coarsening
Implemented in CahnHilliard< dim >, ConservativeLevelSet< dim >, ContinuumSolidDynamics< dim >, HeatTransfer< dim >, TimeHarmonicMaxwell< dim >, and Tracer< dim >.
|
pure virtual |
Set solution vector of Auxiliary Physics using checkpoint.
Implemented in CahnHilliard< dim >, ConservativeLevelSet< dim >, ContinuumSolidDynamics< dim >, HeatTransfer< dim >, TimeHarmonicMaxwell< dim >, and Tracer< dim >.
|
pure virtual |
Sets-up the initial conditions associated with the physics. Generally, physics only support imposing nodal values, but some physics additionally support the use of L2 projection or steady-state solutions.
Implemented in CahnHilliard< dim >, ConservativeLevelSet< dim >, ContinuumSolidDynamics< dim >, HeatTransfer< dim >, TimeHarmonicMaxwell< dim >, and Tracer< dim >.
|
pure virtual |
Sets-up the DofHandler and the degree of freedom associated with the physics.
Implemented in CahnHilliard< dim >, ConservativeLevelSet< dim >, ContinuumSolidDynamics< dim >, HeatTransfer< dim >, TimeHarmonicMaxwell< dim >, and Tracer< dim >.
|
inlineoverridevirtual |
Set up preconditioner. Not used for the auxiliary physics but needed for the compilation of the non-linear solver.
Implements PhysicsSolver< VectorType >.
Reimplemented in TimeHarmonicMaxwell< dim >.
Definition at line 209 of file auxiliary_physics.h.
|
inlinevirtual |
Manage if this auxiliary physics should be solved at the current iteration. By default, auxiliary physics are solved at every iteration.
Reimplemented in ContinuumSolidDynamics< dim >, and TimeHarmonicMaxwell< dim >.
Definition at line 215 of file auxiliary_physics.h.
|
inlinevirtual |
Update non zero constraints if the boundary is time-dependent.
Reimplemented in CahnHilliard< dim >, ConservativeLevelSet< dim >, HeatTransfer< dim >, TimeHarmonicMaxwell< dim >, and Tracer< dim >.
Definition at line 114 of file auxiliary_physics.h.
|
pure virtual |
Prepares auxiliary physics to write checkpoint.
Implemented in CahnHilliard< dim >, ConservativeLevelSet< dim >, ContinuumSolidDynamics< dim >, HeatTransfer< dim >, TimeHarmonicMaxwell< dim >, and Tracer< dim >.