libMesh::SteadySolver Class Reference

This class implements a TimeSolver which does a single solve of the steady state problem. More...

#include <steady_solver.h>

Inheritance diagram for libMesh::SteadySolver:

Public Types
typedef DifferentiableSystem	sys_type
	The type of system. More...
typedef TimeSolver	Parent
	The parent class. More...

Public Member Functions
	SteadySolver (sys_type &s)
	Constructor. More...
virtual	~SteadySolver ()
	Destructor. More...
virtual Real	error_order () const
	error convergence order against deltat is not applicable to a steady problem. More...
virtual bool	element_residual (bool request_jacobian, DiffContext &) override
	This method uses the DifferentiablePhysics' element_time_derivative() and element_constraint() to build a full residual/jacobian on an element. More...
virtual bool	side_residual (bool request_jacobian, DiffContext &) override
	This method uses the DifferentiablePhysics' side_time_derivative() and side_constraint() to build a full residual/jacobian on an element's side. More...
virtual bool	nonlocal_residual (bool request_jacobian, DiffContext &) override
	This method uses the DifferentiablePhysics' nonlocal_time_derivative() and nonlocal_constraint() to build a full residual/jacobian for non-local terms. More...
virtual Real	du (const SystemNorm &) const override
virtual bool	is_steady () const override
	This is a steady-state solver. More...
virtual void	integrate_qoi_timestep () override
	A method to integrate the system::QoI functionals. More...
virtual void	integrate_adjoint_sensitivity (const QoISet &qois, const ParameterVector &parameter_vector, SensitivityData &sensitivities) override
	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) override
	A method to compute the adjoint refinement error estimate at the current timestep. 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	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...
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
virtual bool	_general_residual (bool request_jacobian, DiffContext &, ResFuncType time_deriv, ResFuncType constraint)
	This method is the underlying implementation of the public residual methods. More...
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...

Detailed Description

This class implements a TimeSolver which does a single solve of the steady state problem.

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 47 of file steady_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.

Parent

typedef TimeSolver libMesh::SteadySolver::Parent

The parent class.

Definition at line 58 of file steady_solver.h.

ReinitFuncType

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

protectedinherited

Definition at line 327 of file time_solver.h.

ResFuncType

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

protectedinherited

Definitions of argument types for use in refactoring subclasses.

Definition at line 325 of file time_solver.h.

sys_type

typedef DifferentiableSystem libMesh::SteadySolver::sys_type

The type of system.

Definition at line 53 of file steady_solver.h.

Constructor & Destructor Documentation

SteadySolver()

libMesh::SteadySolver::SteadySolver ( sys_type &  s )

inlineexplicit

Constructor.

Requires a reference to the system to be solved.

Definition at line 65 of file steady_solver.h.

: Parent(s) {}

~SteadySolver()

libMesh::SteadySolver::~SteadySolver ( )

virtualdefault

Destructor.

Member Function Documentation

_general_residual()

bool libMesh::SteadySolver::_general_residual ( bool  request_jacobian, DiffContext &  context, ResFuncType  time_deriv, ResFuncType  constraint  )

protectedvirtual

This method is the underlying implementation of the public residual methods.

Definition at line 68 of file steady_solver.C.

References libMesh::TimeSolver::_system, libMesh::DiffContext::fixed_solution_derivative, libMesh::DiffContext::get_elem_fixed_solution(), libMesh::DiffContext::get_elem_solution(), libMesh::DifferentiableSystem::get_physics(), libMesh::libmesh_assert(), and libMesh::System::use_fixed_solution.

Referenced by element_residual(), nonlocal_residual(), and side_residual().

{
  // If a fixed solution is requested, it will just be the current
  // solution
  if (_system.use_fixed_solution)
    {
      context.get_elem_fixed_solution() = context.get_elem_solution();
      context.fixed_solution_derivative = 1.0;
    }

  bool jacobian_computed =
    (_system.get_physics()->*time_deriv)(request_jacobian, context);

  // The user shouldn't compute a jacobian unless requested
  libmesh_assert (request_jacobian || !jacobian_computed);

  bool jacobian_computed2 =
    (_system.get_physics()->*constraint)(jacobian_computed, context);

  // The user shouldn't compute a jacobian unless requested
  libmesh_assert (jacobian_computed || !jacobian_computed2);

  return jacobian_computed2;
}

adjoint_advance_timestep()

void libMesh::TimeSolver::adjoint_advance_timestep ( )

virtualinherited

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.

{
}

adjoint_solve()

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

virtualinherited

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 libMesh::TimeSolver::_system, libMesh::TimeSolver::diff_solver(), libMesh::libmesh_assert(), and libMesh::TimeSolver::system().

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

  return this->_system.ImplicitSystem::adjoint_solve(qoi_indices);
}

advance_timestep()

void libMesh::TimeSolver::advance_timestep ( )

virtualinherited

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.

{
}

before_timestep()

virtual void libMesh::TimeSolver::before_timestep ( )

inlinevirtualinherited

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

inlinevirtualinherited

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 libMesh::TimeSolver::_diff_solver.

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

{ return _diff_solver; }

disable_print_counter_info()

void libMesh::ReferenceCounter::disable_print_counter_info ( )

staticinherited

Definition at line 100 of file reference_counter.C.

References libMesh::ReferenceCounter::_enable_print_counter.

{
  _enable_print_counter = false;
  return;
}

du()

virtual Real libMesh::SteadySolver::du ( const SystemNorm &  ) const

inlineoverridevirtual

Returns

0, but derived classes should override this function to compute the size of the difference between successive solution iterates ||u^{n+1} - u^{n}|| in some norm.

Implements libMesh::TimeSolver.

Definition at line 107 of file steady_solver.h.

{ return 0; }

element_residual()

bool libMesh::SteadySolver::element_residual ( bool  request_jacobian, DiffContext &  context  )

overridevirtual

This method uses the DifferentiablePhysics' element_time_derivative() and element_constraint() to build a full residual/jacobian on an element.

Implements libMesh::TimeSolver.

Definition at line 35 of file steady_solver.C.

References _general_residual(), libMesh::DifferentiablePhysics::element_constraint(), and libMesh::DifferentiablePhysics::element_time_derivative().

{
  return this->_general_residual(request_jacobian,
                                 context,
                                 &DifferentiablePhysics::element_time_derivative,
                                 &DifferentiablePhysics::element_constraint);
}

enable_print_counter_info()

void libMesh::ReferenceCounter::enable_print_counter_info ( )

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.

{
  _enable_print_counter = true;
  return;
}

error_order()

virtual Real libMesh::SteadySolver::error_order ( ) const

inlinevirtual

error convergence order against deltat is not applicable to a steady problem.

Definition at line 76 of file steady_solver.h.

{ return 0.; }

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.

References libMesh::ReferenceCounter::_counts, and libMesh::Quality::name().

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

{
#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
}

get_solution_history()

SolutionHistory & libMesh::TimeSolver::get_solution_history ( )

inherited

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 libMesh::TimeSolver::solution_history.

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

{
  return *solution_history;
}

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.

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

Referenced by libMesh::ReferenceCountedObject< RBParametrized >::ReferenceCountedObject().

{
  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();
  }
}

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.

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

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

{
  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();
  }
}

init()

void libMesh::TimeSolver::init ( )

virtualinherited

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 libMesh::TimeSolver::_system, libMesh::LinearSolver< T >::build(), libMesh::DiffSolver::build(), libMesh::ParallelObject::comm(), libMesh::TimeSolver::diff_solver(), and libMesh::TimeSolver::linear_solver().

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

{
  // 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());
}

init_adjoints()

void libMesh::TimeSolver::init_adjoints ( )

virtualinherited

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 libMesh::TimeSolver::_system, libMesh::System::add_vector(), libMesh::GHOSTED, libMesh::make_range(), and libMesh::System::n_qois().

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

{
  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);
  }

}

init_data()

void libMesh::TimeSolver::init_data ( )

virtualinherited

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 libMesh::TimeSolver::_system, libMesh::TimeSolver::diff_solver(), libMesh::TimeSolver::linear_solver(), libMesh::System::name(), and libMesh::on_command_line().

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

{
  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_names(_system);
}

integrate_adjoint_refinement_error_estimate()

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

overridevirtual

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 from libMesh::TimeSolver.

Definition at line 112 of file steady_solver.C.

References libMesh::AdjointRefinementEstimator::estimate_error(), libMesh::AdjointRefinementEstimator::get_global_QoI_error_estimate(), libMesh::QoISet::has_index(), libMesh::make_range(), and libMesh::AdjointRefinementEstimator::qoi_set().

{
  // Base class assumes a direct steady state error estimate
  adjoint_refinement_error_estimator.estimate_error(_system, QoI_elementwise_error);

  // Also get the spatially integrated errors for all the QoIs in the QoI set
  for (auto j : make_range(_system.n_qois()))
  {
    // Skip this QoI if not in the QoI Set
    if (adjoint_refinement_error_estimator.qoi_set().has_index(j))
    {
      _system.set_qoi_error_estimate(j, adjoint_refinement_error_estimator.get_global_QoI_error_estimate(j));
    }
  }

  return;
}

integrate_adjoint_sensitivity()

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

overridevirtual

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 from libMesh::TimeSolver.

Definition at line 103 of file steady_solver.C.

References libMesh::TimeSolver::_system.

{
  this->_system.ImplicitSystem::adjoint_qoi_parameter_sensitivity(qois, parameter_vector, sensitivities);

  return;
}

integrate_qoi_timestep()

void libMesh::SteadySolver::integrate_qoi_timestep ( )

overridevirtual

A method to integrate the system::QoI functionals.

Reimplemented from libMesh::TimeSolver.

Definition at line 96 of file steady_solver.C.

References libMesh::TimeSolver::_system, and libMesh::ExplicitSystem::assemble_qoi().

{
  this->_system.assemble_qoi();

  return;
}

is_adjoint()

bool libMesh::TimeSolver::is_adjoint ( ) const

inlineinherited

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

Definition at line 277 of file time_solver.h.

References libMesh::TimeSolver::_is_adjoint.

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

  { return _is_adjoint; }

is_steady()

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

inlineoverridevirtual

This is a steady-state solver.

Implements libMesh::TimeSolver.

Definition at line 112 of file steady_solver.h.

{ return true; }

last_completed_timestep_size()

Real libMesh::TimeSolver::last_completed_timestep_size ( )

virtualinherited

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 libMesh::TimeSolver::last_deltat.

{
  return last_deltat;
}

linear_solver()

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

inlinevirtualinherited

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 libMesh::TimeSolver::_linear_solver.

Referenced by libMesh::TimeSolver::init(), libMesh::TimeSolver::init_data(), and libMesh::TimeSolver::reinit().

{ return _linear_solver; }

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.

References libMesh::ReferenceCounter::_n_objects.

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

  { return _n_objects; }

nonlocal_residual()

bool libMesh::SteadySolver::nonlocal_residual ( bool  request_jacobian, DiffContext &  context  )

overridevirtual

This method uses the DifferentiablePhysics' nonlocal_time_derivative() and nonlocal_constraint() to build a full residual/jacobian for non-local terms.

Implements libMesh::TimeSolver.

Definition at line 57 of file steady_solver.C.

References _general_residual(), libMesh::DifferentiablePhysics::nonlocal_constraint(), and libMesh::DifferentiablePhysics::nonlocal_time_derivative().

{
  return this->_general_residual(request_jacobian,
                                 context,
                                 &DifferentiablePhysics::nonlocal_time_derivative,
                                 &DifferentiablePhysics::nonlocal_constraint);
}

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.

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

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

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

reinit()

void libMesh::TimeSolver::reinit ( )

virtualinherited

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 libMesh::TimeSolver::_linear_solver, libMesh::TimeSolver::_system, libMesh::TimeSolver::diff_solver(), libMesh::libmesh_assert(), libMesh::TimeSolver::linear_solver(), libMesh::System::name(), libMesh::on_command_line(), and libMesh::TimeSolver::system().

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

{
  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_names(_system);
}

retrieve_timestep()

void libMesh::TimeSolver::retrieve_timestep ( )

virtualinherited

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.

{
}

set_is_adjoint()

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

inlineinherited

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

Definition at line 284 of file time_solver.h.

References libMesh::TimeSolver::_is_adjoint.

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

  { _is_adjoint = _is_adjoint_value; }

set_solution_history()

void libMesh::TimeSolver::set_solution_history ( const SolutionHistory &  _solution_history )

inherited

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 libMesh::TimeSolver::solution_history.

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

{
  solution_history = _solution_history.clone();
}

side_residual()

bool libMesh::SteadySolver::side_residual ( bool  request_jacobian, DiffContext &  context  )

overridevirtual

This method uses the DifferentiablePhysics' side_time_derivative() and side_constraint() to build a full residual/jacobian on an element's side.

Implements libMesh::TimeSolver.

Definition at line 46 of file steady_solver.C.

References _general_residual(), libMesh::DifferentiablePhysics::side_constraint(), and libMesh::DifferentiablePhysics::side_time_derivative().

{
  return this->_general_residual(request_jacobian,
                                 context,
                                 &DifferentiablePhysics::side_time_derivative,
                                 &DifferentiablePhysics::side_constraint);
}

solve()

void libMesh::TimeSolver::solve ( )

virtualinherited

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 libMesh::TimeSolver::diff_solver(), libMesh::libmesh_assert(), and libMesh::TimeSolver::system().

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

system() [1/2]

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

inlineinherited

Returns

A constant reference to the system we are solving.

Definition at line 210 of file time_solver.h.

References libMesh::TimeSolver::_system.

Referenced by libMesh::TimeSolver::adjoint_solve(), libMesh::TimeSolver::reinit(), and libMesh::TimeSolver::solve().

{ return _system; }

system() [2/2]

sys_type& libMesh::TimeSolver::system ( )

inlineinherited

Returns

A writable reference to the system we are solving.

Definition at line 215 of file time_solver.h.

References libMesh::TimeSolver::_system.

{ return _system; }

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

protectedinherited

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(), libMesh::TimeSolver::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().

_linear_solver

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

protectedinherited

An implicit linear solver to use for adjoint problems.

Definition at line 307 of file time_solver.h.

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

_system

sys_type& libMesh::TimeSolver::_system

protectedinherited

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(), _general_residual(), libMesh::NewmarkSolver::_general_residual(), libMesh::AdaptiveTimeSolver::adjoint_advance_timestep(), libMesh::UnsteadySolver::adjoint_advance_timestep(), libMesh::TwostepTimeSolver::adjoint_solve(), libMesh::UnsteadySolver::adjoint_solve(), libMesh::TimeSolver::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(), libMesh::TimeSolver::init(), libMesh::EigenTimeSolver::init(), libMesh::UnsteadySolver::init_adjoints(), libMesh::TimeSolver::init_adjoints(), libMesh::SecondOrderUnsteadySolver::init_data(), libMesh::UnsteadySolver::init_data(), libMesh::TimeSolver::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(), integrate_adjoint_sensitivity(), libMesh::UnsteadySolver::integrate_adjoint_sensitivity(), libMesh::Euler2Solver::integrate_qoi_timestep(), libMesh::TwostepTimeSolver::integrate_qoi_timestep(), libMesh::EulerSolver::integrate_qoi_timestep(), 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(), libMesh::TimeSolver::reinit(), libMesh::UnsteadySolver::retrieve_timestep(), libMesh::EigenTimeSolver::side_residual(), libMesh::TwostepTimeSolver::solve(), libMesh::UnsteadySolver::solve(), libMesh::EigenTimeSolver::solve(), libMesh::TimeSolver::system(), and libMesh::UnsteadySolver::update().

last_deltat

Real libMesh::TimeSolver::last_deltat

protectedinherited

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(), libMesh::TimeSolver::last_completed_timestep_size(), libMesh::TwostepTimeSolver::solve(), and libMesh::UnsteadySolver::solve().

quiet

bool libMesh::TimeSolver::quiet

inherited

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

reduce_deltat_on_diffsolver_failure

unsigned int libMesh::TimeSolver::reduce_deltat_on_diffsolver_failure

inherited

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

protectedinherited

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(), libMesh::TimeSolver::get_solution_history(), libMesh::UnsteadySolver::retrieve_timestep(), and libMesh::TimeSolver::set_solution_history().

---

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

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