$extrastylesheet
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Protected Types | Protected Member Functions | Protected Attributes | Static Protected Attributes | Private Attributes
libMesh::TimeSolver Class Reference

#include <time_solver.h>

Inheritance diagram for libMesh::TimeSolver:
Inheritance graph
[legend]

List of all members.

Public Types

typedef DifferentiableSystem sys_type

Public Member Functions

 TimeSolver (sys_type &s)
virtual ~TimeSolver ()
virtual void init ()
virtual void init_data ()
virtual void reinit ()
virtual void solve ()
virtual void advance_timestep ()
virtual void adjoint_advance_timestep ()
virtual void retrieve_timestep ()
virtual bool element_residual (bool request_jacobian, DiffContext &)=0
virtual bool side_residual (bool request_jacobian, DiffContext &)=0
virtual bool nonlocal_residual (bool request_jacobian, DiffContext &)=0
virtual void before_timestep ()
const sys_type & system () const
sys_type & system ()
virtual UniquePtr< DiffSolver > & diff_solver ()
virtual UniquePtr
< LinearSolver< Number > > & 		linear_solver ()
virtual Real du (const SystemNorm &norm) const =0
virtual bool is_steady () const =0
void set_solution_history (const SolutionHistory &_solution_history)
bool is_adjoint () const
void set_is_adjoint (bool _is_adjoint_value)

Static Public Member Functions

static std::string get_info ()
static void print_info (std::ostream &out=libMesh::out)
static unsigned int n_objects ()
static void enable_print_counter_info ()
static void disable_print_counter_info ()

Public Attributes

bool quiet
unsigned int reduce_deltat_on_diffsolver_failure

Protected Types

typedef bool(DifferentiablePhysics::* ResFuncType )(bool, DiffContext &)
typedef void(DiffContext::* ReinitFuncType )(Real)
typedef std::map< std::string,
std::pair< unsigned int,
unsigned int > > 		Counts

Protected Member Functions

void increment_constructor_count (const std::string &name)
void increment_destructor_count (const std::string &name)

Protected Attributes

UniquePtr< DiffSolver > _diff_solver
UniquePtr< LinearSolver< Number > > _linear_solver
sys_type & _system
UniquePtr< NumericVector
< Number > > 		old_local_nonlinear_solution
UniquePtr< SolutionHistory > solution_history

Static Protected Attributes

static Counts _counts
static Threads::atomic
< unsigned int > 		_n_objects
static Threads::spin_mutex _mutex
static bool _enable_print_counter = true

Private Attributes

bool _is_adjoint

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 2006

Definition at line 60 of file time_solver.h.

Member Typedef Documentation

typedef std::map<std::string, std::pair<unsigned int, unsigned int> > libMesh::ReferenceCounter::Counts [protected, inherited]

Data structure to log the information. The log is identified by the class name.

Definition at line 113 of file reference_counter.h.

typedef void(DiffContext::* libMesh::TimeSolver::ReinitFuncType)(Real) [protected]

Definition at line 278 of file time_solver.h.

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

Definitions of argument types for use in refactoring subclasses.

Definition at line 276 of file time_solver.h.

typedef DifferentiableSystem libMesh::TimeSolver::sys_type

The type of system

Reimplemented in libMesh::EigenTimeSolver, and libMesh::SteadySolver.

Definition at line 66 of file time_solver.h.

Constructor & Destructor Documentation

libMesh::TimeSolver::TimeSolver ( sys_type &  s) [explicit]

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

Definition at line 29 of file time_solver.C.

  : quiet (true),
    reduce_deltat_on_diffsolver_failure (0),
    _diff_solver (),
    _linear_solver (),
    _system (s),
    solution_history(new NoSolutionHistory()), // Default setting for solution_history
    _is_adjoint (false)
{
}
libMesh::TimeSolver::~TimeSolver ( ) [virtual]

Destructor.

Definition at line 42 of file time_solver.C.

{
}

Member Function Documentation

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::UnsteadySolver.

Definition at line 106 of file time_solver.C.

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

Definition at line 102 of file time_solver.C.

{
}
virtual void libMesh::TimeSolver::before_timestep ( ) [inline, virtual]

This method is for subclasses or users to override to do arbitrary processing between timesteps

Definition at line 168 of file time_solver.h.

{}
virtual UniquePtr<DiffSolver>& libMesh::TimeSolver::diff_solver ( ) [inline, virtual]

An implicit linear or nonlinear solver to use at each timestep.

Reimplemented in libMesh::AdaptiveTimeSolver.

Definition at line 183 of file time_solver.h.

References _diff_solver.

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

{ return _diff_solver; }
void libMesh::ReferenceCounter::disable_print_counter_info ( ) [static, inherited]

Definition at line 106 of file reference_counter.C.

References libMesh::ReferenceCounter::_enable_print_counter.

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

{
  _enable_print_counter = false;
  return;
}
virtual Real libMesh::TimeSolver::du ( const SystemNorm &  norm) const [pure virtual]

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

Note that, 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::UnsteadySolver, and libMesh::SteadySolver.

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

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

void libMesh::ReferenceCounter::enable_print_counter_info ( ) [static, inherited]

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

Definition at line 100 of file reference_counter.C.

References libMesh::ReferenceCounter::_enable_print_counter.

{
  _enable_print_counter = true;
  return;
}
std::string libMesh::ReferenceCounter::get_info ( ) [static, inherited]

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 (Counts::iterator it = _counts.begin();
       it != _counts.end(); ++it)
    {
      const std::string name(it->first);
      const unsigned int creations    = it->second.first;
      const unsigned int destructions = it->second.second;

      oss << "| " << name << " reference count information:\n"
          << "|  Creations:    " << creations    << '\n'
          << "|  Destructions: " << destructions << '\n';
    }

  oss << " ---------------------------------------------------------------------------- \n";

  return oss.str();

#else

  return "";

#endif
}
void libMesh::ReferenceCounter::increment_constructor_count ( const std::string &  name) [inline, protected, inherited]

Increments the construction counter. Should be called in the constructor of any derived class that will be reference counted.

Definition at line 163 of file reference_counter.h.

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

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

{
  Threads::spin_mutex::scoped_lock lock(Threads::spin_mtx);
  std::pair<unsigned int, unsigned int>& p = _counts[name];

  p.first++;
}
void libMesh::ReferenceCounter::increment_destructor_count ( const std::string &  name) [inline, protected, inherited]

Increments the destruction counter. Should be called in the destructor of any derived class that will be reference counted.

Definition at line 176 of file reference_counter.h.

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

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

{
  Threads::spin_mutex::scoped_lock lock(Threads::spin_mtx);
  std::pair<unsigned int, unsigned int>& p = _counts[name];

  p.second++;
}
void libMesh::TimeSolver::init ( ) [virtual]

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

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

Definition at line 64 of file time_solver.C.

References _system, libMesh::DiffSolver::build(), libMesh::ParallelObject::comm(), diff_solver(), and linear_solver().

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

  if (this->linear_solver().get() == NULL)
    this->linear_solver() = LinearSolver<Number>::build(_system.comm());
}
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::UnsteadySolver.

Definition at line 77 of file time_solver.C.

References _system, diff_solver(), linear_solver(), libMesh::System::name(), and libMesh::on_command_line().

{
  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();
}
bool libMesh::TimeSolver::is_adjoint ( ) const [inline]

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.

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

  { return _is_adjoint; }
virtual bool libMesh::TimeSolver::is_steady ( ) const [pure virtual]

Is this effectively a steady-state solver?

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

virtual UniquePtr<LinearSolver<Number> >& libMesh::TimeSolver::linear_solver ( ) [inline, virtual]

An implicit linear solver to use for adjoint and sensitivity problems.

Reimplemented in libMesh::AdaptiveTimeSolver.

Definition at line 188 of file time_solver.h.

References _linear_solver.

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

{ return _linear_solver; }
static unsigned int libMesh::ReferenceCounter::n_objects ( ) [inline, static, inherited]

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

Definition at line 79 of file reference_counter.h.

References libMesh::ReferenceCounter::_n_objects.

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

  { return _n_objects; }
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::EigenTimeSolver, libMesh::SteadySolver, libMesh::AdaptiveTimeSolver, libMesh::Euler2Solver, and libMesh::EulerSolver.

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

void libMesh::ReferenceCounter::print_info ( std::ostream &  out = libMesh::out) [static, inherited]

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

Definition at line 88 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();
}
void libMesh::TimeSolver::reinit ( ) [virtual]

The reinitialization function. This method is used after changes in the mesh

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

Definition at line 48 of file time_solver.C.

References _system, diff_solver(), libMesh::libmesh_assert(), linear_solver(), libMesh::System::name(), libMesh::on_command_line(), and system().

{
  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();
}
void libMesh::TimeSolver::retrieve_timestep ( ) [virtual]

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

Reimplemented in libMesh::UnsteadySolver.

Definition at line 110 of file time_solver.C.

{
}
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 240 of file time_solver.h.

References _is_adjoint.

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

  { _is_adjoint = _is_adjoint_value; }
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 97 of file time_solver.C.

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

{
  solution_history = _solution_history.clone();
}
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::EigenTimeSolver, libMesh::AdaptiveTimeSolver, libMesh::SteadySolver, libMesh::Euler2Solver, and libMesh::EulerSolver.

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

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

Definition at line 89 of file time_solver.C.

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

{
  libmesh_assert(this->diff_solver().get());
  libmesh_assert_equal_to (&(this->diff_solver()->system()), &(this->system()));
  this->diff_solver()->solve();
}
const sys_type& libMesh::TimeSolver::system ( ) const [inline]
Returns:
a constant reference to the system we are solving.

Definition at line 173 of file time_solver.h.

References _system.

Referenced by reinit(), and solve().

{ return _system; }
sys_type& libMesh::TimeSolver::system ( ) [inline]
Returns:
a writeable reference to the system we are solving.

Definition at line 178 of file time_solver.h.

References _system.

{ return _system; }

Member Data Documentation

ReferenceCounter::Counts libMesh::ReferenceCounter::_counts [static, protected, inherited]

Actually holds the data.

Definition at line 118 of file reference_counter.h.

Referenced by libMesh::ReferenceCounter::get_info(), libMesh::ReferenceCounter::increment_constructor_count(), and libMesh::ReferenceCounter::increment_destructor_count().

UniquePtr<DiffSolver> libMesh::TimeSolver::_diff_solver [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(), and libMesh::UnsteadySolver::solve().

bool libMesh::ReferenceCounter::_enable_print_counter = true [static, protected, inherited]

Flag to control whether reference count information is printed when print_info is called.

Definition at line 137 of file reference_counter.h.

Referenced by libMesh::ReferenceCounter::disable_print_counter_info(), libMesh::ReferenceCounter::enable_print_counter_info(), and libMesh::ReferenceCounter::print_info().

bool libMesh::TimeSolver::_is_adjoint [private]

This boolean tells the TimeSolver whether we are solving a primal or adjoint problem

Definition at line 286 of file time_solver.h.

Referenced by is_adjoint(), and set_is_adjoint().

UniquePtr<LinearSolver<Number> > libMesh::TimeSolver::_linear_solver [protected]

An implicit linear solver to use for adjoint problems.

Definition at line 253 of file time_solver.h.

Referenced by linear_solver().

Threads::spin_mutex libMesh::ReferenceCounter::_mutex [static, protected, inherited]

Mutual exclusion object to enable thread-safe reference counting.

Definition at line 131 of file reference_counter.h.

Threads::atomic< unsigned int > libMesh::ReferenceCounter::_n_objects [static, protected, inherited]

The number of objects. Print the reference count information when the number returns to 0.

Definition at line 126 of file reference_counter.h.

Referenced by libMesh::ReferenceCounter::n_objects(), libMesh::ReferenceCounter::ReferenceCounter(), and libMesh::ReferenceCounter::~ReferenceCounter().

sys_type& libMesh::TimeSolver::_system [protected]

A reference to the system we are solving.

Definition at line 258 of file time_solver.h.

Referenced by libMesh::EulerSolver::_general_residual(), libMesh::Euler2Solver::_general_residual(), libMesh::SteadySolver::_general_residual(), libMesh::UnsteadySolver::adjoint_advance_timestep(), libMesh::AdaptiveTimeSolver::advance_timestep(), libMesh::UnsteadySolver::advance_timestep(), libMesh::UnsteadySolver::du(), libMesh::EigenTimeSolver::element_residual(), libMesh::UnsteadySolver::init(), init(), libMesh::EigenTimeSolver::init(), libMesh::UnsteadySolver::init_data(), init_data(), libMesh::EigenTimeSolver::nonlocal_residual(), libMesh::UnsteadySolver::old_nonlinear_solution(), libMesh::UnsteadySolver::reinit(), reinit(), libMesh::UnsteadySolver::retrieve_timestep(), libMesh::EigenTimeSolver::side_residual(), libMesh::TwostepTimeSolver::solve(), libMesh::UnsteadySolver::solve(), libMesh::EigenTimeSolver::solve(), and system().

UniquePtr<NumericVector<Number> > libMesh::TimeSolver::old_local_nonlinear_solution [protected]

Serial vector of _system.get_vector("_old_nonlinear_solution")

Reimplemented in libMesh::UnsteadySolver.

Definition at line 263 of file time_solver.h.

bool libMesh::TimeSolver::quiet

Print extra debugging information if quiet == false.

Definition at line 193 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. Note that this has no effect for SteadySolvers. Note that 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 221 of file time_solver.h.

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

UniquePtr<SolutionHistory> libMesh::TimeSolver::solution_history [protected]

An UniquePtr 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 270 of file time_solver.h.

Referenced by libMesh::UnsteadySolver::adjoint_advance_timestep(), libMesh::UnsteadySolver::advance_timestep(), libMesh::UnsteadySolver::retrieve_timestep(), and set_solution_history().

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