libMesh::TimeSolver Class Reference

#include <time_solver.h>

Inheritance diagram for libMesh::TimeSolver:

[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 void	before_timestep ()
const sys_type &	system () const
sys_type &	system ()
virtual AutoPtr< DiffSolver > &	diff_solver ()
virtual AutoPtr< 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 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
AutoPtr< DiffSolver >	_diff_solver
AutoPtr< LinearSolver< Number > >	_linear_solver
sys_type &	_system
bool	first_solve
AutoPtr< NumericVector< Number > >	old_local_nonlinear_solution
AutoPtr< 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 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 (NULL),
    _linear_solver (NULL),
    _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 100 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::AdaptiveTimeSolver, libMesh::EigenTimeSolver, and libMesh::UnsteadySolver.

Definition at line 96 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 152 of file time_solver.h.

{}

virtual AutoPtr<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 167 of file time_solver.h.

References _diff_solver.

{ 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.

{
  _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::SteadySolver, and libMesh::UnsteadySolver.

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

This method uses the DifferentiableSystem's element_time_derivative() and element_constraint() 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, and libMesh::SteadySolver.

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

Definition at line 61 of file time_solver.C.

References _diff_solver, _linear_solver, _system, libMesh::DiffSolver::build(), and libMesh::AutoPtr< Tp >::get().

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

  if (_linear_solver.get() == NULL)
    _linear_solver = LinearSolver<Number>::build();

  _diff_solver->init();
  _linear_solver->init();
}

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.

{
}

bool libMesh::TimeSolver::is_adjoint

(

)

const [inline]

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

Definition at line 217 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::SteadySolver, and libMesh::UnsteadySolver.

virtual AutoPtr<LinearSolver<Number> >& libMesh::TimeSolver::linear_solver

(

)

[inline, virtual]

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

Definition at line 172 of file time_solver.h.

References _linear_solver.

{ 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.

  { return _n_objects; }

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

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

Definition at line 48 of file time_solver.C.

References _diff_solver, _linear_solver, libMesh::AutoPtr< Tp >::get(), and system().

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

  libmesh_assert(_linear_solver.get());
  _linear_solver->clear();
  _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 104 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 224 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 91 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 DifferentiableSystem's side_time_derivative() and side_constraint() 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, and libMesh::SteadySolver.

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

Definition at line 83 of file time_solver.C.

References _diff_solver, libMesh::AutoPtr< Tp >::get(), and system().

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

sys_type& libMesh::TimeSolver::system

(

)

[inline]

Returns:

a writeable reference to the system we are solving.

Definition at line 162 of file time_solver.h.

References _system.

{ return _system; }

const sys_type& libMesh::TimeSolver::system

(

)

const [inline]

Returns:

a constant reference to the system we are solving.

Definition at line 157 of file time_solver.h.

References _system.

Referenced by reinit(), and solve().

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

AutoPtr<DiffSolver> libMesh::TimeSolver::_diff_solver [protected]

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

Definition at line 232 of file time_solver.h.

Referenced by diff_solver(), init(), reinit(), libMesh::UnsteadySolver::solve(), and 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 268 of file time_solver.h.

Referenced by is_adjoint(), and set_is_adjoint().

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

An implicit linear solver to use for adjoint problems.

Definition at line 237 of file time_solver.h.

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

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

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

bool libMesh::TimeSolver::first_solve [protected]

A bool that will be true the first time solve() is called, and false thereafter

Reimplemented in libMesh::UnsteadySolver.

Definition at line 248 of file time_solver.h.

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

bool libMesh::TimeSolver::quiet

Print extra debugging information if quiet == false.

Definition at line 177 of file time_solver.h.

Referenced by libMesh::UnsteadySolver::solve(), libMesh::TwostepTimeSolver::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 205 of file time_solver.h.

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

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

An AutoPtr 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 260 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:

• time_solver.h
• time_solver.C