libMesh
|
This is a generic class that defines a solver to handle time integration of DifferentiableSystems. More...
#include <time_solver.h>
Public Types | |
typedef DifferentiableSystem | sys_type |
The type of system. More... | |
Public Member Functions | |
TimeSolver (sys_type &s) | |
Constructor. More... | |
virtual | ~TimeSolver () |
Destructor. More... | |
virtual void | init () |
The initialization function. More... | |
virtual void | init_adjoints () |
Initialize any adjoint related data structures, based on the number of qois. More... | |
virtual void | init_data () |
The data initialization function. More... | |
virtual void | reinit () |
The reinitialization function. More... | |
virtual void | solve () |
This method solves for the solution at the next timestep (or solves for a steady-state solution). More... | |
virtual void | advance_timestep () |
This method advances the solution to the next timestep, after a solve() has been performed. More... | |
virtual std::pair< unsigned int, Real > | adjoint_solve (const QoISet &qoi_indices) |
This method solves for the adjoint solution at the next adjoint timestep (or a steady state adjoint solve) More... | |
virtual void | adjoint_advance_timestep () |
This method advances the adjoint solution to the previous timestep, after an adjoint_solve() has been performed. More... | |
virtual void | retrieve_timestep () |
This method retrieves all the stored solutions at the current system.time. More... | |
virtual void | integrate_qoi_timestep () |
A method to integrate the system::QoI functionals. More... | |
virtual void | integrate_adjoint_sensitivity (const QoISet &qois, const ParameterVector ¶meter_vector, SensitivityData &sensitivities) |
A method to integrate the adjoint sensitivity w.r.t a given parameter vector. More... | |
virtual void | integrate_adjoint_refinement_error_estimate (AdjointRefinementEstimator &adjoint_refinement_error_estimator, ErrorVector &QoI_elementwise_error) |
A method to compute the adjoint refinement error estimate at the current timestep. More... | |
virtual bool | element_residual (bool request_jacobian, DiffContext &)=0 |
This method uses the DifferentiablePhysics element_time_derivative(), element_constraint(), and mass_residual() to build a full residual on an element. More... | |
virtual bool | side_residual (bool request_jacobian, DiffContext &)=0 |
This method uses the DifferentiablePhysics side_time_derivative(), side_constraint(), and side_mass_residual() to build a full residual on an element's side. More... | |
virtual bool | nonlocal_residual (bool request_jacobian, DiffContext &)=0 |
This method uses the DifferentiablePhysics nonlocal_time_derivative(), nonlocal_constraint(), and nonlocal_mass_residual() to build a full residual of non-local terms. More... | |
virtual void | before_timestep () |
This method is for subclasses or users to override to do arbitrary processing between timesteps. More... | |
const sys_type & | system () const |
sys_type & | system () |
virtual std::unique_ptr< DiffSolver > & | diff_solver () |
An implicit linear or nonlinear solver to use at each timestep. More... | |
virtual std::unique_ptr< LinearSolver< Number > > & | linear_solver () |
An implicit linear solver to use for adjoint and sensitivity problems. More... | |
virtual Real | du (const SystemNorm &norm) const =0 |
Computes the size of ||u^{n+1} - u^{n}|| in some norm. More... | |
virtual bool | is_steady () const =0 |
Is this effectively a steady-state solver? More... | |
void | set_solution_history (const SolutionHistory &_solution_history) |
A setter function users will employ if they need to do something other than save no solution history. More... | |
SolutionHistory & | get_solution_history () |
A getter function that returns a reference to the solution history object owned by TimeSolver. More... | |
bool | is_adjoint () const |
Accessor for querying whether we need to do a primal or adjoint solve. More... | |
void | set_is_adjoint (bool _is_adjoint_value) |
Accessor for setting whether we need to do a primal or adjoint solve. More... | |
virtual Real | last_completed_timestep_size () |
Returns system.deltat if fixed timestep solver is used, the complete timestep size (sum of all substeps) if the adaptive time solver is used. More... | |
Static Public Member Functions | |
static std::string | get_info () |
Gets a string containing the reference information. More... | |
static void | print_info (std::ostream &out_stream=libMesh::out) |
Prints the reference information, by default to libMesh::out . More... | |
static unsigned int | n_objects () |
Prints the number of outstanding (created, but not yet destroyed) objects. More... | |
static void | enable_print_counter_info () |
Methods to enable/disable the reference counter output from print_info() More... | |
static void | disable_print_counter_info () |
Public Attributes | |
bool | quiet |
Print extra debugging information if quiet == false. More... | |
unsigned int | reduce_deltat_on_diffsolver_failure |
This value (which defaults to zero) is the number of times the TimeSolver is allowed to halve deltat and let the DiffSolver repeat the latest failed solve with a reduced timestep. More... | |
Protected Types | |
typedef bool(DifferentiablePhysics::* | ResFuncType) (bool, DiffContext &) |
Definitions of argument types for use in refactoring subclasses. More... | |
typedef void(DiffContext::* | ReinitFuncType) (Real) |
typedef std::map< std::string, std::pair< unsigned int, unsigned int > > | Counts |
Data structure to log the information. More... | |
Protected Member Functions | |
void | increment_constructor_count (const std::string &name) noexcept |
Increments the construction counter. More... | |
void | increment_destructor_count (const std::string &name) noexcept |
Increments the destruction counter. More... | |
Protected Attributes | |
std::unique_ptr< DiffSolver > | _diff_solver |
An implicit linear or nonlinear solver to use at each timestep. More... | |
std::unique_ptr< LinearSolver< Number > > | _linear_solver |
An implicit linear solver to use for adjoint problems. More... | |
sys_type & | _system |
A reference to the system we are solving. More... | |
std::unique_ptr< SolutionHistory > | solution_history |
A std::unique_ptr to a SolutionHistory object. More... | |
Real | last_deltat |
The deltat for the last completed timestep before the current one. More... | |
Static Protected Attributes | |
static Counts | _counts |
Actually holds the data. More... | |
static Threads::atomic< unsigned int > | _n_objects |
The number of objects. More... | |
static Threads::spin_mutex | _mutex |
Mutual exclusion object to enable thread-safe reference counting. More... | |
static bool | _enable_print_counter = true |
Flag to control whether reference count information is printed when print_info is called. More... | |
Private Attributes | |
bool | _is_adjoint |
This boolean tells the TimeSolver whether we are solving a primal or adjoint problem. More... | |
This is a generic class that defines a solver to handle time integration of DifferentiableSystems.
A user can define a solver by deriving from this class and implementing certain functions.
This class is part of the new DifferentiableSystem framework, which is still experimental. Users of this framework should beware of bugs and future API changes.
Definition at line 63 of file time_solver.h.
|
protectedinherited |
Data structure to log the information.
The log is identified by the class name.
Definition at line 119 of file reference_counter.h.
|
protected |
Definition at line 327 of file time_solver.h.
|
protected |
Definitions of argument types for use in refactoring subclasses.
Definition at line 325 of file time_solver.h.
The type of system.
Definition at line 69 of file time_solver.h.
|
explicit |
Constructor.
Requires a reference to the system to be solved.
Definition at line 36 of file time_solver.C.
|
virtualdefault |
Destructor.
|
virtual |
This method advances the adjoint solution to the previous timestep, after an adjoint_solve() has been performed.
This will be done before every UnsteadySolver::adjoint_solve().
Reimplemented in libMesh::UnsteadySolver, libMesh::AdaptiveTimeSolver, and libMesh::NewmarkSolver.
Definition at line 165 of file time_solver.C.
|
virtual |
This method solves for the adjoint solution at the next adjoint timestep (or a steady state adjoint solve)
Reimplemented in libMesh::UnsteadySolver, libMesh::AdaptiveTimeSolver, and libMesh::TwostepTimeSolver.
Definition at line 133 of file time_solver.C.
References _system, diff_solver(), libMesh::libmesh_assert(), and system().
|
virtual |
This method advances the solution to the next timestep, after a solve() has been performed.
Often this will be done after every UnsteadySolver::solve(), but adaptive mesh refinement and/or adaptive time step selection may require some solve() steps to be repeated.
Reimplemented in libMesh::EigenTimeSolver, libMesh::UnsteadySolver, libMesh::AdaptiveTimeSolver, and libMesh::NewmarkSolver.
Definition at line 129 of file time_solver.C.
|
inlinevirtual |
This method is for subclasses or users to override to do arbitrary processing between timesteps.
Definition at line 205 of file time_solver.h.
|
inlinevirtual |
An implicit linear or nonlinear solver to use at each timestep.
Reimplemented in libMesh::AdaptiveTimeSolver.
Definition at line 220 of file time_solver.h.
References _diff_solver.
Referenced by adjoint_solve(), adjust_linear_solvers(), init(), init_data(), reinit(), and solve().
|
staticinherited |
Definition at line 100 of file reference_counter.C.
References libMesh::ReferenceCounter::_enable_print_counter.
|
pure virtual |
Computes the size of ||u^{n+1} - u^{n}|| in some norm.
Implemented in libMesh::UnsteadySolver, libMesh::EigenTimeSolver, and libMesh::SteadySolver.
|
pure virtual |
This method uses the DifferentiablePhysics element_time_derivative(), element_constraint(), and mass_residual() to build a full residual on an element.
What combination
it uses will depend on the type of solver. See the subclasses for more details.
Implemented in libMesh::EigenTimeSolver, libMesh::NewmarkSolver, libMesh::AdaptiveTimeSolver, libMesh::Euler2Solver, libMesh::SteadySolver, and libMesh::EulerSolver.
Referenced by libMesh::FEMSystem::numerical_elem_jacobian().
|
staticinherited |
Methods to enable/disable the reference counter output from print_info()
Definition at line 94 of file reference_counter.C.
References libMesh::ReferenceCounter::_enable_print_counter.
|
staticinherited |
Gets a string containing the reference information.
Definition at line 47 of file reference_counter.C.
References libMesh::ReferenceCounter::_counts, and libMesh::Quality::name().
Referenced by libMesh::ReferenceCounter::print_info().
SolutionHistory & libMesh::TimeSolver::get_solution_history | ( | ) |
A getter function that returns a reference to the solution history object owned by TimeSolver.
Definition at line 124 of file time_solver.C.
References solution_history.
Referenced by libMesh::AdaptiveTimeSolver::init().
|
inlineprotectednoexceptinherited |
Increments the construction counter.
Should be called in the constructor of any derived class that will be reference counted.
Definition at line 183 of file reference_counter.h.
References libMesh::err, libMesh::BasicOStreamProxy< charT, traits >::get(), libMesh::Quality::name(), and libMesh::Threads::spin_mtx.
Referenced by libMesh::ReferenceCountedObject< RBParametrized >::ReferenceCountedObject().
|
inlineprotectednoexceptinherited |
Increments the destruction counter.
Should be called in the destructor of any derived class that will be reference counted.
Definition at line 207 of file reference_counter.h.
References libMesh::err, libMesh::BasicOStreamProxy< charT, traits >::get(), libMesh::Quality::name(), and libMesh::Threads::spin_mtx.
Referenced by libMesh::ReferenceCountedObject< RBParametrized >::~ReferenceCountedObject().
|
virtual |
The initialization function.
This method is used to initialize internal data structures before a simulation begins.
Reimplemented in libMesh::EigenTimeSolver, libMesh::AdaptiveTimeSolver, libMesh::UnsteadySolver, and libMesh::SecondOrderUnsteadySolver.
Definition at line 72 of file time_solver.C.
References _system, libMesh::LinearSolver< T >::build(), libMesh::DiffSolver::build(), libMesh::ParallelObject::comm(), diff_solver(), and linear_solver().
Referenced by libMesh::UnsteadySolver::init().
|
virtual |
Initialize any adjoint related data structures, based on the number of qois.
Reimplemented in libMesh::UnsteadySolver.
Definition at line 83 of file time_solver.C.
References _system, libMesh::System::add_vector(), libMesh::GHOSTED, libMesh::make_range(), and libMesh::System::n_qois().
Referenced by libMesh::UnsteadySolver::init_adjoints().
|
virtual |
The data initialization function.
This method is used to initialize internal data structures after the underlying System has been initialized
Reimplemented in libMesh::UnsteadySolver, and libMesh::SecondOrderUnsteadySolver.
Definition at line 97 of file time_solver.C.
References _system, diff_solver(), linear_solver(), libMesh::System::name(), and libMesh::on_command_line().
Referenced by libMesh::UnsteadySolver::init_data().
|
virtual |
A method to compute the adjoint refinement error estimate at the current timestep.
int_{tstep_start}^{tstep_end} R(u^h,z) dt The user provides an initialized ARefEE object. Fills in an ErrorVector that contains the weighted sum of errors from all the QoIs and can be used to guide AMR. CURRENTLY ONLY SUPPORTED for Backward Euler.
Reimplemented in libMesh::UnsteadySolver, libMesh::SteadySolver, libMesh::EulerSolver, libMesh::FirstOrderUnsteadySolver, libMesh::TwostepTimeSolver, libMesh::AdaptiveTimeSolver, and libMesh::Euler2Solver.
Definition at line 153 of file time_solver.C.
|
virtual |
A method to integrate the adjoint sensitivity w.r.t a given parameter vector.
int_{tstep_start}^{tstep_end} dQ/dp dt = int_{tstep_start}^{tstep_end} ( / p) - ( R (u,z) / p ) dt
Reimplemented in libMesh::UnsteadySolver, libMesh::SteadySolver, libMesh::AdaptiveTimeSolver, and libMesh::TwostepTimeSolver.
Definition at line 146 of file time_solver.C.
|
virtual |
A method to integrate the system::QoI functionals.
Reimplemented in libMesh::UnsteadySolver, libMesh::SteadySolver, libMesh::EulerSolver, libMesh::FirstOrderUnsteadySolver, libMesh::AdaptiveTimeSolver, libMesh::TwostepTimeSolver, and libMesh::Euler2Solver.
Definition at line 141 of file time_solver.C.
|
inline |
Accessor for querying whether we need to do a primal or adjoint solve.
Definition at line 277 of file time_solver.h.
References _is_adjoint.
Referenced by libMesh::FEMSystem::build_context().
|
pure virtual |
Is this effectively a steady-state solver?
Implemented in libMesh::UnsteadySolver, libMesh::EigenTimeSolver, and libMesh::SteadySolver.
Referenced by libMesh::DiffContext::DiffContext(), and libMesh::FEMContext::pre_fe_reinit().
|
virtual |
Returns system.deltat if fixed timestep solver is used, the complete timestep size (sum of all substeps) if the adaptive time solver is used.
Returns the change in system.time, deltat, for the last timestep which was successfully completed. This only returns the outermost step size in the case of nested time solvers. If no time step has yet been successfully completed, then returns system.deltat.
Reimplemented in libMesh::AdaptiveTimeSolver.
Definition at line 160 of file time_solver.C.
References last_deltat.
|
inlinevirtual |
An implicit linear solver to use for adjoint and sensitivity problems.
Reimplemented in libMesh::AdaptiveTimeSolver.
Definition at line 225 of file time_solver.h.
References _linear_solver.
Referenced by init(), init_data(), and reinit().
|
inlinestaticinherited |
Prints the number of outstanding (created, but not yet destroyed) objects.
Definition at line 85 of file reference_counter.h.
References libMesh::ReferenceCounter::_n_objects.
Referenced by libMesh::LibMeshInit::~LibMeshInit().
|
pure virtual |
This method uses the DifferentiablePhysics nonlocal_time_derivative(), nonlocal_constraint(), and nonlocal_mass_residual() to build a full residual of non-local terms.
What combination it uses will depend on the type of solver. See the subclasses for more details.
Implemented in libMesh::NewmarkSolver, libMesh::EigenTimeSolver, libMesh::Euler2Solver, libMesh::AdaptiveTimeSolver, libMesh::SteadySolver, and libMesh::EulerSolver.
Referenced by libMesh::FEMSystem::numerical_nonlocal_jacobian().
|
staticinherited |
Prints the reference information, by default to libMesh::out
.
Definition at line 81 of file reference_counter.C.
References libMesh::ReferenceCounter::_enable_print_counter, and libMesh::ReferenceCounter::get_info().
Referenced by libMesh::LibMeshInit::~LibMeshInit().
|
virtual |
The reinitialization function.
This method is used after changes in the mesh
Reimplemented in libMesh::EigenTimeSolver, libMesh::UnsteadySolver, libMesh::SecondOrderUnsteadySolver, and libMesh::AdaptiveTimeSolver.
Definition at line 54 of file time_solver.C.
References _linear_solver, _system, diff_solver(), libMesh::libmesh_assert(), linear_solver(), libMesh::System::name(), libMesh::on_command_line(), and system().
Referenced by libMesh::UnsteadySolver::reinit().
|
virtual |
This method retrieves all the stored solutions at the current system.time.
Reimplemented in libMesh::UnsteadySolver, libMesh::SecondOrderUnsteadySolver, and libMesh::AdaptiveTimeSolver.
Definition at line 169 of file time_solver.C.
|
inline |
Accessor for setting whether we need to do a primal or adjoint solve.
Definition at line 284 of file time_solver.h.
References _is_adjoint.
Referenced by libMesh::DifferentiableSystem::adjoint_solve(), libMesh::FEMSystem::postprocess(), and libMesh::DifferentiableSystem::solve().
void libMesh::TimeSolver::set_solution_history | ( | const SolutionHistory & | _solution_history | ) |
A setter function users will employ if they need to do something other than save no solution history.
Definition at line 119 of file time_solver.C.
References libMesh::SolutionHistory::clone(), and solution_history.
Referenced by libMesh::AdaptiveTimeSolver::init().
|
pure virtual |
This method uses the DifferentiablePhysics side_time_derivative(), side_constraint(), and side_mass_residual() to build a full residual on an element's side.
What combination it uses will depend on the type of solver. See the subclasses for more details.
Implemented in libMesh::NewmarkSolver, libMesh::EigenTimeSolver, libMesh::AdaptiveTimeSolver, libMesh::Euler2Solver, libMesh::SteadySolver, and libMesh::EulerSolver.
Referenced by libMesh::FEMSystem::numerical_side_jacobian().
|
virtual |
This method solves for the solution at the next timestep (or solves for a steady-state solution).
Usually we will only need to solve one (non)linear system per timestep, but more complex subclasses may override this.
Reimplemented in libMesh::NewmarkSolver, libMesh::EigenTimeSolver, libMesh::UnsteadySolver, libMesh::AdaptiveTimeSolver, and libMesh::TwostepTimeSolver.
Definition at line 111 of file time_solver.C.
References diff_solver(), libMesh::libmesh_assert(), and system().
|
inline |
Definition at line 210 of file time_solver.h.
References _system.
Referenced by adjoint_solve(), reinit(), and solve().
|
inline |
Definition at line 215 of file time_solver.h.
References _system.
|
staticprotectedinherited |
Actually holds the data.
Definition at line 124 of file reference_counter.h.
Referenced by libMesh::ReferenceCounter::get_info().
|
protected |
An implicit linear or nonlinear solver to use at each timestep.
Definition at line 302 of file time_solver.h.
Referenced by libMesh::NewmarkSolver::compute_initial_accel(), diff_solver(), and libMesh::UnsteadySolver::solve().
|
staticprotectedinherited |
Flag to control whether reference count information is printed when print_info is called.
Definition at line 143 of file reference_counter.h.
Referenced by libMesh::ReferenceCounter::disable_print_counter_info(), libMesh::ReferenceCounter::enable_print_counter_info(), and libMesh::ReferenceCounter::print_info().
|
private |
This boolean tells the TimeSolver whether we are solving a primal or adjoint problem.
Definition at line 340 of file time_solver.h.
Referenced by is_adjoint(), and set_is_adjoint().
|
protected |
An implicit linear solver to use for adjoint problems.
Definition at line 307 of file time_solver.h.
Referenced by linear_solver(), and reinit().
|
staticprotectedinherited |
Mutual exclusion object to enable thread-safe reference counting.
Definition at line 137 of file reference_counter.h.
|
staticprotectedinherited |
The number of objects.
Print the reference count information when the number returns to 0.
Definition at line 132 of file reference_counter.h.
Referenced by libMesh::ReferenceCounter::n_objects(), libMesh::ReferenceCounter::ReferenceCounter(), and libMesh::ReferenceCounter::~ReferenceCounter().
|
protected |
A reference to the system we are solving.
Definition at line 312 of file time_solver.h.
Referenced by libMesh::EulerSolver::_general_residual(), libMesh::Euler2Solver::_general_residual(), libMesh::SteadySolver::_general_residual(), libMesh::NewmarkSolver::_general_residual(), libMesh::AdaptiveTimeSolver::adjoint_advance_timestep(), libMesh::UnsteadySolver::adjoint_advance_timestep(), libMesh::TwostepTimeSolver::adjoint_solve(), libMesh::UnsteadySolver::adjoint_solve(), adjoint_solve(), libMesh::NewmarkSolver::advance_timestep(), libMesh::AdaptiveTimeSolver::advance_timestep(), libMesh::UnsteadySolver::advance_timestep(), libMesh::NewmarkSolver::compute_initial_accel(), libMesh::FirstOrderUnsteadySolver::compute_second_order_eqns(), libMesh::UnsteadySolver::du(), libMesh::EulerSolver::element_residual(), libMesh::Euler2Solver::element_residual(), libMesh::EigenTimeSolver::element_residual(), libMesh::SecondOrderUnsteadySolver::init(), libMesh::UnsteadySolver::init(), init(), libMesh::EigenTimeSolver::init(), libMesh::UnsteadySolver::init_adjoints(), init_adjoints(), libMesh::SecondOrderUnsteadySolver::init_data(), libMesh::UnsteadySolver::init_data(), init_data(), libMesh::Euler2Solver::integrate_adjoint_refinement_error_estimate(), libMesh::TwostepTimeSolver::integrate_adjoint_refinement_error_estimate(), libMesh::EulerSolver::integrate_adjoint_refinement_error_estimate(), libMesh::TwostepTimeSolver::integrate_adjoint_sensitivity(), libMesh::SteadySolver::integrate_adjoint_sensitivity(), libMesh::UnsteadySolver::integrate_adjoint_sensitivity(), libMesh::Euler2Solver::integrate_qoi_timestep(), libMesh::TwostepTimeSolver::integrate_qoi_timestep(), libMesh::EulerSolver::integrate_qoi_timestep(), libMesh::SteadySolver::integrate_qoi_timestep(), libMesh::EulerSolver::nonlocal_residual(), libMesh::Euler2Solver::nonlocal_residual(), libMesh::EigenTimeSolver::nonlocal_residual(), libMesh::UnsteadySolver::old_nonlinear_solution(), libMesh::SecondOrderUnsteadySolver::old_solution_accel(), libMesh::SecondOrderUnsteadySolver::old_solution_rate(), libMesh::NewmarkSolver::project_initial_accel(), libMesh::SecondOrderUnsteadySolver::project_initial_rate(), libMesh::SecondOrderUnsteadySolver::reinit(), libMesh::UnsteadySolver::reinit(), reinit(), libMesh::UnsteadySolver::retrieve_timestep(), libMesh::EigenTimeSolver::side_residual(), libMesh::TwostepTimeSolver::solve(), libMesh::UnsteadySolver::solve(), libMesh::EigenTimeSolver::solve(), system(), and libMesh::UnsteadySolver::update().
|
protected |
The deltat for the last completed timestep before the current one.
Definition at line 332 of file time_solver.h.
Referenced by libMesh::TwostepTimeSolver::adjoint_solve(), libMesh::UnsteadySolver::adjoint_solve(), last_completed_timestep_size(), libMesh::TwostepTimeSolver::solve(), and libMesh::UnsteadySolver::solve().
bool libMesh::TimeSolver::quiet |
Print extra debugging information if quiet == false.
Definition at line 230 of file time_solver.h.
Referenced by libMesh::TwostepTimeSolver::solve(), libMesh::UnsteadySolver::solve(), and libMesh::EigenTimeSolver::solve().
unsigned int libMesh::TimeSolver::reduce_deltat_on_diffsolver_failure |
This value (which defaults to zero) is the number of times the TimeSolver is allowed to halve deltat and let the DiffSolver repeat the latest failed solve with a reduced timestep.
Definition at line 259 of file time_solver.h.
Referenced by libMesh::TwostepTimeSolver::solve(), and libMesh::UnsteadySolver::solve().
|
protected |
A std::unique_ptr to a SolutionHistory object.
Default is NoSolutionHistory, which the user can override by declaring a different kind of SolutionHistory in the application
Definition at line 319 of file time_solver.h.
Referenced by libMesh::UnsteadySolver::adjoint_advance_timestep(), libMesh::UnsteadySolver::advance_timestep(), get_solution_history(), libMesh::UnsteadySolver::retrieve_timestep(), and set_solution_history().