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_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 steadystate solution). More...  
virtual void  advance_timestep () 
This method advances the solution to the next timestep, after a solve() has been performed. 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 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 nonlocal 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 steadystate 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...  
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...  
Static Public Member Functions  
static std::string  get_info () 
Gets a string containing the reference information. More...  
static void  print_info (std::ostream &out=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) 
Increments the construction counter. More...  
void  increment_destructor_count (const std::string &name) 
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...  
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 threadsafe reference counting. More...  
static bool  _enable_print_counter 
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 59 of file time_solver.h.

protectedinherited 
Data structure to log the information.
The log is identified by the class name.
Definition at line 117 of file reference_counter.h.

protected 
Definition at line 273 of file time_solver.h.

protected 
Definitions of argument types for use in refactoring subclasses.
Definition at line 271 of file time_solver.h.
The type of system.
Definition at line 65 of file time_solver.h.

explicit 
Constructor.
Requires a reference to the system to be solved.

virtual 
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, and libMesh::NewmarkSolver.

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.

virtual 
This method is for subclasses or users to override to do arbitrary processing between timesteps.
Definition at line 167 of file time_solver.h.

virtual 
An implicit linear or nonlinear solver to use at each timestep.
Reimplemented in libMesh::AdaptiveTimeSolver.
Definition at line 182 of file time_solver.h.
References _diff_solver.

staticinherited 

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::SteadySolver, libMesh::Euler2Solver, and libMesh::EulerSolver.

staticinherited 
Methods to enable/disable the reference counter output from print_info()

staticinherited 
Gets a string containing the reference information.

protectedinherited 
Increments the construction counter.
Should be called in the constructor of any derived class that will be reference counted.
Definition at line 181 of file reference_counter.h.
References libMesh::ReferenceCounter::_counts, libMesh::Quality::name(), and libMesh::Threads::spin_mtx.
Referenced by libMesh::ReferenceCountedObject< RBParametrized >::ReferenceCountedObject().

protectedinherited 
Increments the destruction counter.
Should be called in the destructor of any derived class that will be reference counted.
Definition at line 194 of file reference_counter.h.
References libMesh::ReferenceCounter::_counts, 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.

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.
bool libMesh::TimeSolver::is_adjoint  (  )  const 
Accessor for querying whether we need to do a primal or adjoint solve.
Definition at line 233 of file time_solver.h.
References _is_adjoint.

pure virtual 
Is this effectively a steadystate solver?
Implemented in libMesh::UnsteadySolver, libMesh::EigenTimeSolver, and libMesh::SteadySolver.

virtual 
An implicit linear solver to use for adjoint and sensitivity problems.
Reimplemented in libMesh::AdaptiveTimeSolver.
Definition at line 187 of file time_solver.h.
References _linear_solver.

staticinherited 
Prints the number of outstanding (created, but not yet destroyed) objects.
Definition at line 83 of file reference_counter.h.
References libMesh::ReferenceCounter::_n_objects.

pure virtual 
This method uses the DifferentiablePhysics nonlocal_time_derivative(), nonlocal_constraint(), and nonlocal_mass_residual() to build a full residual of nonlocal 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::SteadySolver, libMesh::AdaptiveTimeSolver, libMesh::Euler2Solver, and libMesh::EulerSolver.

staticinherited 
Prints the reference information, by default to libMesh::out
.

virtual 
The reinitialization function.
This method is used after changes in the mesh
Reimplemented in libMesh::EigenTimeSolver, libMesh::UnsteadySolver, libMesh::SecondOrderUnsteadySolver, and libMesh::AdaptiveTimeSolver.

virtual 
This method retrieves all the stored solutions at the current system.time.
Reimplemented in libMesh::UnsteadySolver, and libMesh::SecondOrderUnsteadySolver.
void libMesh::TimeSolver::set_is_adjoint  (  bool  _is_adjoint_value  ) 
Accessor for setting whether we need to do a primal or adjoint solve.
Definition at line 240 of file time_solver.h.
References _is_adjoint.
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.

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::SteadySolver, libMesh::Euler2Solver, and libMesh::EulerSolver.

virtual 
This method solves for the solution at the next timestep (or solves for a steadystate 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.
const sys_type& libMesh::TimeSolver::system  (  )  const 
Definition at line 172 of file time_solver.h.
References _system.
sys_type& libMesh::TimeSolver::system  (  ) 
Definition at line 177 of file time_solver.h.
References _system.

staticprotectedinherited 
Actually holds the data.
Definition at line 122 of file reference_counter.h.
Referenced by libMesh::ReferenceCounter::increment_constructor_count(), and libMesh::ReferenceCounter::increment_destructor_count().

protected 
An implicit linear or nonlinear solver to use at each timestep.
Definition at line 248 of file time_solver.h.
Referenced by diff_solver().

staticprotectedinherited 
Flag to control whether reference count information is printed when print_info is called.
Definition at line 141 of file reference_counter.h.

private 
This boolean tells the TimeSolver whether we are solving a primal or adjoint problem.
Definition at line 281 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 253 of file time_solver.h.
Referenced by linear_solver().

staticprotectedinherited 
Mutual exclusion object to enable threadsafe reference counting.
Definition at line 135 of file reference_counter.h.

staticprotectedinherited 
The number of objects.
Print the reference count information when the number returns to 0.
Definition at line 130 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 258 of file time_solver.h.
Referenced by system().
bool libMesh::TimeSolver::quiet 
Print extra debugging information if quiet == false.
Definition at line 192 of file time_solver.h.
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 221 of file time_solver.h.

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 265 of file time_solver.h.