libMesh::TimeSolver Class Reference

This is a generic class that defines a solver to handle time integration of DifferentiableSystems. More...

#include <time_solver.h>

Inheritance diagram for libMesh::TimeSolver:

Public Types
typedef DifferentiableSystem	sys_type
	The type of system.

Public Member Functions
	TimeSolver (sys_type &s)
	Constructor.
virtual	~TimeSolver ()
	Destructor.
virtual void	init ()
	The initialization function.
virtual void	init_adjoints ()
	Initialize any adjoint related data structures, based on the number of qois.
virtual void	init_data ()
	The data initialization function.
virtual void	reinit ()
	The reinitialization function.
virtual void	solve ()
	This method solves for the solution at the next timestep (or solves for a steady-state solution).
virtual void	advance_timestep ()
	This method advances the solution to the next timestep, after a solve() has been performed.
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)
virtual void	adjoint_advance_timestep ()
	This method advances the adjoint solution to the previous timestep, after an adjoint_solve() has been performed.
virtual void	retrieve_timestep ()
	This method retrieves all the stored solutions at the current system.time.
virtual void	integrate_qoi_timestep ()
	A method to integrate the system::QoI functionals.
virtual void	integrate_adjoint_sensitivity (const QoISet &qois, const ParameterVector &parameter_vector, SensitivityData &sensitivities)
	A method to integrate the adjoint sensitivity w.r.t a given parameter vector.
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.
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.
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.
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.
virtual void	before_timestep ()
	This method is for subclasses or users to override to do arbitrary processing between timesteps.
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.
virtual std::unique_ptr< LinearSolver< Number > > &	linear_solver ()
	An implicit linear solver to use for adjoint and sensitivity problems.
virtual Real	du (const SystemNorm &norm) const =0
	Computes the size of ||u^{n+1} - u^{n}|| in some norm.
virtual bool	is_steady () const =0
	Is this effectively a steady-state solver?
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.
SolutionHistory &	get_solution_history ()
	A getter function that returns a reference to the solution history object owned by TimeSolver.
bool	is_adjoint () const
	Accessor for querying whether we need to do a primal or adjoint solve.
void	set_is_adjoint (bool _is_adjoint_value)
	Accessor for setting whether we need to do a primal or adjoint solve.
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.

Static Public Member Functions
static std::string	get_info ()
	Gets a string containing the reference information.
static void	print_info (std::ostream &out_stream=libMesh::out)
	Prints the reference information, by default to libMesh::out.
static unsigned int	n_objects ()
	Prints the number of outstanding (created, but not yet destroyed) objects.
static void	enable_print_counter_info ()
	Methods to enable/disable the reference counter output from print_info().
static void	disable_print_counter_info ()

Public Attributes
bool	quiet
	Print extra debugging information if quiet == false.
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.

Protected Types
typedef bool(DifferentiablePhysics::*	ResFuncType) (bool, DiffContext &)
	Definitions of argument types for use in refactoring subclasses.
typedef void(DiffContext::*	ReinitFuncType) (Real)
typedef std::map< std::string, std::pair< unsigned int, unsigned int > >	Counts
	Data structure to log the information.

Protected Member Functions
void	increment_constructor_count (const std::string &name) noexcept
	Increments the construction counter.
void	increment_destructor_count (const std::string &name) noexcept
	Increments the destruction counter.

Protected Attributes
std::unique_ptr< DiffSolver >	_diff_solver
	An implicit linear or nonlinear solver to use at each timestep.
std::unique_ptr< LinearSolver< Number > >	_linear_solver
	An implicit linear solver to use for adjoint problems.
sys_type &	_system
	A reference to the system we are solving.
std::unique_ptr< SolutionHistory >	solution_history
	A std::unique_ptr to a SolutionHistory object.
Real	last_deltat
	The deltat for the last completed timestep before the current one.

Static Protected Attributes
static Counts	_counts
	Actually holds the data.
static Threads::atomic< unsigned int >	_n_objects
	The number of objects.
static Threads::spin_mutex	_mutex
	Mutual exclusion object to enable thread-safe reference counting.
static bool	_enable_print_counter = true
	Flag to control whether reference count information is printed when print_info is called.

Private Attributes
bool	_is_adjoint
	This boolean tells the TimeSolver whether we are solving a primal or adjoint problem.

Detailed Description

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.

Author

Roy H. Stogner

Date

2006

Definition at line 63 of file time_solver.h.

Member Typedef Documentation

Counts

typedef std::map<std::string, std::pair<unsigned int, unsigned int> > libMesh::ReferenceCounter::Counts

protectedinherited

Data structure to log the information.

The log is identified by the class name.

Definition at line 119 of file reference_counter.h.

ReinitFuncType

typedef void(DiffContext::* libMesh::TimeSolver::ReinitFuncType) (Real)

protected

Definition at line 327 of file time_solver.h.

ResFuncType

typedef bool(DifferentiablePhysics::* libMesh::TimeSolver::ResFuncType) (bool, DiffContext &)

protected

Definitions of argument types for use in refactoring subclasses.

Definition at line 325 of file time_solver.h.

sys_type

typedef DifferentiableSystem libMesh::TimeSolver::sys_type

The type of system.

Definition at line 69 of file time_solver.h.

Constructor & Destructor Documentation

TimeSolver()

libMesh::TimeSolver::TimeSolver ( sys_type &  s )

explicit

Constructor.

Requires a reference to the system to be solved.

Definition at line 36 of file time_solver.C.

  : quiet (true),
    reduce_deltat_on_diffsolver_failure (0),
    _diff_solver (),
    _linear_solver (),
    _system (s),
    solution_history(std::make_unique<NoSolutionHistory>()),
    last_deltat (s.deltat),
    _is_adjoint (false)
{
}

~TimeSolver()

libMesh::TimeSolver::~TimeSolver ( )

virtualdefault

Destructor.

Member Function Documentation

adjoint_advance_timestep()

void libMesh::TimeSolver::adjoint_advance_timestep ( )

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

Definition at line 165 of file time_solver.C.

{
}

adjoint_solve()

std::pair< unsigned int, Real > libMesh::TimeSolver::adjoint_solve ( const QoISet &  qoi_indices )

virtual

This method solves for the adjoint solution at the next adjoint timestep (or a steady state adjoint solve)

Reimplemented in libMesh::TwostepTimeSolver, libMesh::UnsteadySolver, and libMesh::AdaptiveTimeSolver.

Definition at line 133 of file time_solver.C.

{
  libmesh_assert(this->diff_solver().get());
  libmesh_assert_equal_to (&(this->diff_solver()->system()), &(this->system()));
 
  return this->_system.ImplicitSystem::adjoint_solve(qoi_indices);
}

References _system, diff_solver(), libMesh::libmesh_assert(), and system().

advance_timestep()

void libMesh::TimeSolver::advance_timestep ( )

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::AdaptiveTimeSolver, libMesh::EigenTimeSolver, libMesh::NewmarkSolver, and libMesh::UnsteadySolver.

Definition at line 129 of file time_solver.C.

{
}

before_timestep()

virtual void libMesh::TimeSolver::before_timestep ( )

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.

{}

diff_solver()

virtual std::unique_ptr< DiffSolver > & libMesh::TimeSolver::diff_solver ( )

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.

{ return _diff_solver; }

References _diff_solver.

Referenced by adjoint_solve(), adjust_linear_solvers(), init(), init_data(), reinit(), and solve().

disable_print_counter_info()

void libMesh::ReferenceCounter::disable_print_counter_info ( )

staticinherited

Definition at line 100 of file reference_counter.C.

{
  _enable_print_counter = false;
  return;
}

References libMesh::ReferenceCounter::_enable_print_counter.

du()

virtual Real libMesh::TimeSolver::du ( const SystemNorm &  norm ) const

pure virtual

Computes the size of ||u^{n+1} - u^{n}|| in some norm.

Note

While you can always call this function, its result may or may not be very meaningful. For example, if you call this function right after calling advance_timestep() then you'll get a result of zero since old_nonlinear_solution is set equal to nonlinear_solution in this function.

Implemented in libMesh::EigenTimeSolver, libMesh::SteadySolver, and libMesh::UnsteadySolver.

element_residual()

virtual bool libMesh::TimeSolver::element_residual ( bool  request_jacobian, DiffContext &    )

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

Referenced by libMesh::FEMSystem::numerical_elem_jacobian().

enable_print_counter_info()

void libMesh::ReferenceCounter::enable_print_counter_info ( )

staticinherited

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

Enabled by default.

Definition at line 94 of file reference_counter.C.

{
  _enable_print_counter = true;
  return;
}

References libMesh::ReferenceCounter::_enable_print_counter.

Referenced by libMesh::LibMeshInit::~LibMeshInit().

get_info()

std::string libMesh::ReferenceCounter::get_info ( )

staticinherited

Gets a string containing the reference information.

Definition at line 47 of file reference_counter.C.

{
#if defined(LIBMESH_ENABLE_REFERENCE_COUNTING) && defined(DEBUG)
 
  std::ostringstream oss;
 
  oss << '\n'
      << " ---------------------------------------------------------------------------- \n"
      << "| Reference count information                                                |\n"
      << " ---------------------------------------------------------------------------- \n";
 
  for (const auto & [name, cd] : _counts)
    oss << "| " << name << " reference count information:\n"
        << "|  Creations:    " << cd.first    << '\n'
        << "|  Destructions: " << cd.second << '\n';
 
  oss << " ---------------------------------------------------------------------------- \n";
 
  return oss.str();
 
#else
 
  return "";
 
#endif
}

References libMesh::ReferenceCounter::_counts.

Referenced by libMesh::ReferenceCounter::print_info().

get_solution_history()

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.

{
  return *solution_history;
}

References solution_history.

Referenced by libMesh::AdaptiveTimeSolver::init().

increment_constructor_count()

void libMesh::ReferenceCounter::increment_constructor_count ( const std::string &  name )

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.

{
  libmesh_try
  {
    Threads::spin_mutex::scoped_lock lock(Threads::spin_mtx);
    std::pair<unsigned int, unsigned int> & p = _counts[name];
    p.first++;
  }
  libmesh_catch (...)
  {
    auto stream = libMesh::err.get();
    stream->exceptions(stream->goodbit); // stream must not throw
    libMesh::err << "Encountered unrecoverable error while calling "
                 << "ReferenceCounter::increment_constructor_count() "
                 << "for a(n) " << name << " object." << std::endl;
    std::terminate();
  }
}

References libMesh::err, libMesh::BasicOStreamProxy< charT, traits >::get(), and libMesh::Threads::spin_mtx.

Referenced by libMesh::ReferenceCountedObject< T >::ReferenceCountedObject(), libMesh::ReferenceCountedObject< T >::ReferenceCountedObject(), and libMesh::ReferenceCountedObject< T >::ReferenceCountedObject().

increment_destructor_count()

void libMesh::ReferenceCounter::increment_destructor_count ( const std::string &  name )

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.

{
  libmesh_try
  {
    Threads::spin_mutex::scoped_lock lock(Threads::spin_mtx);
    std::pair<unsigned int, unsigned int> & p = _counts[name];
    p.second++;
  }
  libmesh_catch (...)
  {
    auto stream = libMesh::err.get();
    stream->exceptions(stream->goodbit); // stream must not throw
    libMesh::err << "Encountered unrecoverable error while calling "
                 << "ReferenceCounter::increment_destructor_count() "
                 << "for a(n) " << name << " object." << std::endl;
    std::terminate();
  }
}

References libMesh::err, libMesh::BasicOStreamProxy< charT, traits >::get(), and libMesh::Threads::spin_mtx.

Referenced by libMesh::ReferenceCountedObject< T >::~ReferenceCountedObject().

init()

void libMesh::TimeSolver::init ( )

virtual

The initialization function.

This method is used to initialize internal data structures before a simulation begins.

Reimplemented in libMesh::AdaptiveTimeSolver, libMesh::EigenTimeSolver, libMesh::SecondOrderUnsteadySolver, and libMesh::UnsteadySolver.

Definition at line 72 of file time_solver.C.

{
  // If the user hasn't given us a solver to use,
  // just build a default solver
  if (this->diff_solver().get() == nullptr)
    this->diff_solver() = DiffSolver::build(_system);
 
  if (this->linear_solver().get() == nullptr)
    this->linear_solver() = LinearSolver<Number>::build(_system.comm());
}

References _system, libMesh::LinearSolver< T >::build(), libMesh::DiffSolver::build(), libMesh::ParallelObject::comm(), diff_solver(), and linear_solver().

Referenced by libMesh::UnsteadySolver::init().

init_adjoints()

void libMesh::TimeSolver::init_adjoints ( )

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.

{
  libmesh_assert_msg(_system.n_qois() != 0, "System qois have to be initialized before initializing adjoints.");
 
  // Add adjoint vectors
  for(auto i : make_range(_system.n_qois()))
  {
    std::string adjoint_solution_name = "adjoint_solution";
    adjoint_solution_name+= std::to_string(i);
    _system.add_vector(adjoint_solution_name, false, GHOSTED);
  }
 
}

References _system, libMesh::System::add_vector(), libMesh::GHOSTED, libMesh::make_range(), and libMesh::System::n_qois().

Referenced by libMesh::UnsteadySolver::init_adjoints().

init_data()

void libMesh::TimeSolver::init_data ( )

virtual

The data initialization function.

This method is used to initialize internal data structures after the underlying System has been initialized

Reimplemented in libMesh::SecondOrderUnsteadySolver, and libMesh::UnsteadySolver.

Definition at line 97 of file time_solver.C.

{
  this->diff_solver()->init();
 
  if (libMesh::on_command_line("--solver-system-names"))
    this->linear_solver()->init((_system.name()+"_").c_str());
  else
    this->linear_solver()->init();
 
  this->linear_solver()->init_systems(_system);
}

References _system, diff_solver(), libMesh::NumericVector< T >::init(), linear_solver(), libMesh::System::name(), and libMesh::on_command_line().

Referenced by libMesh::UnsteadySolver::init_data().

integrate_adjoint_refinement_error_estimate()

void libMesh::TimeSolver::integrate_adjoint_refinement_error_estimate ( AdjointRefinementEstimator &  adjoint_refinement_error_estimator, ErrorVector &  QoI_elementwise_error  )

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

Definition at line 152 of file time_solver.C.

{
  libmesh_not_implemented();
}

integrate_adjoint_sensitivity()

void libMesh::TimeSolver::integrate_adjoint_sensitivity ( const QoISet &  qois, const ParameterVector &  parameter_vector, SensitivityData &  sensitivities  )

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} (\partialQ / \partial p) - ( \partial R (u,z) / \partial p ) dt

Reimplemented in libMesh::SteadySolver, libMesh::TwostepTimeSolver, libMesh::UnsteadySolver, and libMesh::AdaptiveTimeSolver.

Definition at line 146 of file time_solver.C.

{
  libmesh_not_implemented();
}

integrate_qoi_timestep()

void libMesh::TimeSolver::integrate_qoi_timestep ( )

virtual

A method to integrate the system::QoI functionals.

Reimplemented in libMesh::Euler2Solver, libMesh::EulerSolver, libMesh::SteadySolver, libMesh::TwostepTimeSolver, libMesh::UnsteadySolver, libMesh::AdaptiveTimeSolver, and libMesh::FirstOrderUnsteadySolver.

Definition at line 141 of file time_solver.C.

{
  libmesh_not_implemented();
}

is_adjoint()

bool libMesh::TimeSolver::is_adjoint ( ) const

inline

Accessor for querying whether we need to do a primal or adjoint solve.

Definition at line 277 of file time_solver.h.

  { return _is_adjoint; }

References _is_adjoint.

Referenced by libMesh::FEMSystem::build_context().

is_steady()

virtual bool libMesh::TimeSolver::is_steady ( ) const

pure virtual

Is this effectively a steady-state solver?

Implemented in libMesh::EigenTimeSolver, libMesh::SteadySolver, and libMesh::UnsteadySolver.

Referenced by libMesh::DiffContext::DiffContext(), and libMesh::FEMContext::pre_fe_reinit().

last_completed_timestep_size()

Real libMesh::TimeSolver::last_completed_timestep_size ( )

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.

{
  return last_deltat;
}

References last_deltat.

linear_solver()

virtual std::unique_ptr< LinearSolver< Number > > & libMesh::TimeSolver::linear_solver ( )

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.

{ return _linear_solver; }

References _linear_solver.

Referenced by init(), init_data(), and reinit().

n_objects()

static unsigned int libMesh::ReferenceCounter::n_objects ( )

inlinestaticinherited

Prints the number of outstanding (created, but not yet destroyed) objects.

Definition at line 85 of file reference_counter.h.

  { return _n_objects; }

References libMesh::ReferenceCounter::_n_objects.

Referenced by libMesh::LibMeshInit::~LibMeshInit().

nonlocal_residual()

virtual bool libMesh::TimeSolver::nonlocal_residual ( bool  request_jacobian, DiffContext &    )

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

Referenced by libMesh::FEMSystem::numerical_nonlocal_jacobian().

print_info()

void libMesh::ReferenceCounter::print_info ( std::ostream &  out_stream = libMesh::out )

staticinherited

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

Definition at line 81 of file reference_counter.C.

{
  if (_enable_print_counter)
    out_stream << ReferenceCounter::get_info();
}

References libMesh::ReferenceCounter::_enable_print_counter, and libMesh::ReferenceCounter::get_info().

Referenced by libMesh::LibMeshInit::~LibMeshInit().

reinit()

void libMesh::TimeSolver::reinit ( )

virtual

The reinitialization function.

This method is used after changes in the mesh

Reimplemented in libMesh::AdaptiveTimeSolver, libMesh::EigenTimeSolver, libMesh::SecondOrderUnsteadySolver, and libMesh::UnsteadySolver.

Definition at line 54 of file time_solver.C.

{
  libmesh_assert(this->diff_solver().get());
  libmesh_assert_equal_to (&(this->diff_solver()->system()), &(this->system()));
  this->diff_solver()->reinit();
 
  libmesh_assert(this->linear_solver().get());
  this->linear_solver()->clear();
  if (libMesh::on_command_line("--solver-system-names"))
    this->linear_solver()->init((_system.name()+"_").c_str());
  else
    this->linear_solver()->init();
 
  this->_linear_solver->init_systems(_system);
}

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().

retrieve_timestep()

void libMesh::TimeSolver::retrieve_timestep ( )

virtual

This method retrieves all the stored solutions at the current system.time.

Reimplemented in libMesh::AdaptiveTimeSolver, libMesh::SecondOrderUnsteadySolver, and libMesh::UnsteadySolver.

Definition at line 169 of file time_solver.C.

{
}

set_is_adjoint()

void libMesh::TimeSolver::set_is_adjoint ( bool  _is_adjoint_value )

inline

Accessor for setting whether we need to do a primal or adjoint solve.

Definition at line 284 of file time_solver.h.

  { _is_adjoint = _is_adjoint_value; }

References _is_adjoint.

Referenced by libMesh::DifferentiableSystem::adjoint_solve(), libMesh::FEMSystem::postprocess(), and libMesh::DifferentiableSystem::solve().

set_solution_history()

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.

{
  solution_history = _solution_history.clone();
}

References libMesh::SolutionHistory::clone(), and solution_history.

Referenced by libMesh::AdaptiveTimeSolver::init().

side_residual()

virtual bool libMesh::TimeSolver::side_residual ( bool  request_jacobian, DiffContext &    )

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

Referenced by libMesh::FEMSystem::numerical_side_jacobian().

solve()

void libMesh::TimeSolver::solve ( )

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::EigenTimeSolver, libMesh::NewmarkSolver, libMesh::TwostepTimeSolver, libMesh::UnsteadySolver, and libMesh::AdaptiveTimeSolver.

Definition at line 111 of file time_solver.C.

{
  libmesh_assert(this->diff_solver().get());
  libmesh_assert_equal_to (&(this->diff_solver()->system()), &(this->system()));
  this->diff_solver()->solve();
}

References diff_solver(), libMesh::libmesh_assert(), and system().

system() [1/2]

sys_type & libMesh::TimeSolver::system ( )

inline

Returns

A writable reference to the system we are solving.

Definition at line 215 of file time_solver.h.

{ return _system; }

References _system.

system() [2/2]

const sys_type & libMesh::TimeSolver::system ( ) const

inline

Returns

A constant reference to the system we are solving.

Definition at line 210 of file time_solver.h.

{ return _system; }

References _system.

Referenced by adjoint_solve(), reinit(), and solve().

Member Data Documentation

_counts

ReferenceCounter::Counts libMesh::ReferenceCounter::_counts

staticprotectedinherited

Actually holds the data.

Definition at line 124 of file reference_counter.h.

Referenced by libMesh::ReferenceCounter::get_info().

_diff_solver

std::unique_ptr<DiffSolver> libMesh::TimeSolver::_diff_solver

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().

_enable_print_counter

bool libMesh::ReferenceCounter::_enable_print_counter = true

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().

_is_adjoint

bool libMesh::TimeSolver::_is_adjoint

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().

_linear_solver

std::unique_ptr<LinearSolver<Number> > libMesh::TimeSolver::_linear_solver

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().

_mutex

Threads::spin_mutex libMesh::ReferenceCounter::_mutex

staticprotectedinherited

Mutual exclusion object to enable thread-safe reference counting.

Definition at line 137 of file reference_counter.h.

_n_objects

Threads::atomic< unsigned int > libMesh::ReferenceCounter::_n_objects

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(), libMesh::ReferenceCounter::ReferenceCounter(), libMesh::ReferenceCounter::ReferenceCounter(), and libMesh::ReferenceCounter::~ReferenceCounter().

_system

sys_type& libMesh::TimeSolver::_system

protected

A reference to the system we are solving.

Definition at line 312 of file time_solver.h.

Referenced by libMesh::NewmarkSolver::_general_residual(), libMesh::Euler2Solver::_general_residual(), libMesh::EulerSolver::_general_residual(), libMesh::SteadySolver::_general_residual(), libMesh::AdaptiveTimeSolver::adjoint_advance_timestep(), libMesh::UnsteadySolver::adjoint_advance_timestep(), adjoint_solve(), libMesh::TwostepTimeSolver::adjoint_solve(), libMesh::UnsteadySolver::adjoint_solve(), libMesh::AdaptiveTimeSolver::advance_timestep(), libMesh::NewmarkSolver::advance_timestep(), libMesh::UnsteadySolver::advance_timestep(), libMesh::NewmarkSolver::compute_initial_accel(), libMesh::FirstOrderUnsteadySolver::compute_second_order_eqns(), libMesh::UnsteadySolver::du(), libMesh::EigenTimeSolver::element_residual(), libMesh::Euler2Solver::element_residual(), libMesh::EulerSolver::element_residual(), init(), libMesh::EigenTimeSolver::init(), libMesh::SecondOrderUnsteadySolver::init(), libMesh::UnsteadySolver::init(), init_adjoints(), libMesh::UnsteadySolver::init_adjoints(), init_data(), libMesh::SecondOrderUnsteadySolver::init_data(), libMesh::UnsteadySolver::init_data(), libMesh::Euler2Solver::integrate_adjoint_refinement_error_estimate(), libMesh::EulerSolver::integrate_adjoint_refinement_error_estimate(), libMesh::SteadySolver::integrate_adjoint_refinement_error_estimate(), libMesh::TwostepTimeSolver::integrate_adjoint_refinement_error_estimate(), libMesh::SteadySolver::integrate_adjoint_sensitivity(), libMesh::TwostepTimeSolver::integrate_adjoint_sensitivity(), libMesh::UnsteadySolver::integrate_adjoint_sensitivity(), libMesh::Euler2Solver::integrate_qoi_timestep(), libMesh::EulerSolver::integrate_qoi_timestep(), libMesh::SteadySolver::integrate_qoi_timestep(), libMesh::TwostepTimeSolver::integrate_qoi_timestep(), libMesh::EigenTimeSolver::nonlocal_residual(), libMesh::Euler2Solver::nonlocal_residual(), libMesh::EulerSolver::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(), reinit(), libMesh::SecondOrderUnsteadySolver::reinit(), libMesh::UnsteadySolver::reinit(), libMesh::UnsteadySolver::retrieve_timestep(), libMesh::EigenTimeSolver::side_residual(), libMesh::EigenTimeSolver::solve(), libMesh::TwostepTimeSolver::solve(), libMesh::UnsteadySolver::solve(), system(), system(), and libMesh::UnsteadySolver::update().

last_deltat

Real libMesh::TimeSolver::last_deltat

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().

quiet

bool libMesh::TimeSolver::quiet

Print extra debugging information if quiet == false.

Definition at line 230 of file time_solver.h.

Referenced by libMesh::EigenTimeSolver::solve(), libMesh::TwostepTimeSolver::solve(), and libMesh::UnsteadySolver::solve().

reduce_deltat_on_diffsolver_failure

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.

Note

This has no effect for SteadySolvers.

You must set at least one of the DiffSolver flags "continue_after_max_iterations" or "continue_after_backtrack_failure" to allow the TimeSolver to retry the solve.

Definition at line 259 of file time_solver.h.

Referenced by libMesh::TwostepTimeSolver::solve(), and libMesh::UnsteadySolver::solve().

solution_history

std::unique_ptr<SolutionHistory> libMesh::TimeSolver::solution_history

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().

---

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

• include/solvers/time_solver.h
• src/solvers/time_solver.C