#include <euler2_solver.h>

Inheritance diagram for libMesh::Euler2Solver:

[legend]

Public Types
typedef FirstOrderUnsteadySolver	Parent

typedef DifferentiableSystem	sys_type

Public Member Functions
	Euler2Solver (sys_type &s)

virtual	~Euler2Solver ()

virtual Real	error_order () const override

virtual bool	element_residual (bool request_jacobian, DiffContext &) override

virtual bool	side_residual (bool request_jacobian, DiffContext &) override

virtual bool	nonlocal_residual (bool request_jacobian, DiffContext &) override

virtual unsigned int	time_order () const override

virtual void	init () override

virtual void	init_data () override

virtual void	reinit () override

virtual void	solve () override

virtual void	advance_timestep () override

virtual void	adjoint_advance_timestep () override

virtual void	retrieve_timestep () override

Number	old_nonlinear_solution (const dof_id_type global_dof_number) const

virtual Real	du (const SystemNorm &norm) const override

virtual bool	is_steady () const override

virtual void	before_timestep ()

const sys_type &	system () const

sys_type &	system ()

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

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

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
Real	theta

std::unique_ptr< NumericVector< Number > >	old_local_nonlinear_solution

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
virtual bool	_general_residual (bool request_jacobian, DiffContext &, ResFuncType mass, ResFuncType damping, ResFuncType time_deriv, ResFuncType constraint, ReinitFuncType reinit, bool compute_second_order_eqns)

void	prepare_accel (DiffContext &context)

bool	compute_second_order_eqns (bool compute_jacobian, DiffContext &c)

void	increment_constructor_count (const std::string &name)

void	increment_destructor_count (const std::string &name)

Protected Attributes
bool	first_solve

bool	first_adjoint_step

std::unique_ptr< DiffSolver >	_diff_solver

std::unique_ptr< LinearSolver< Number > >	_linear_solver

sys_type &	_system

std::unique_ptr< 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

Detailed Description

This class defines a theta-method (defaulting to Backward Euler with theta = 1.0) solver to handle time integration of DifferentiableSystems. The "Euler2" solver differs from Euler in how it evaluates residuals at intermediate theta values: Euler solves m(u,u') = f(theta*u_new + (1-theta)*u_old), Euler2 solves m(u') = theta*f(u_new) + (1-theta)*f(u_old) i.e. the trapezoidal rule for theta = 0.5

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 48 of file euler2_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 117 of file reference_counter.h.

◆ Parent

typedef FirstOrderUnsteadySolver libMesh::Euler2Solver::Parent

The parent class

Definition at line 54 of file euler2_solver.h.

◆ ReinitFuncType

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

protectedinherited

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

◆ sys_type

typedef DifferentiableSystem libMesh::TimeSolver::sys_type

inherited

The type of system

Definition at line 65 of file time_solver.h.

Constructor & Destructor Documentation

◆ Euler2Solver()

libMesh::Euler2Solver::Euler2Solver ( sys_type & s )

explicit

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

Definition at line 27 of file euler2_solver.C.

   : FirstOrderUnsteadySolver(s), theta(1.)
 {
 }

◆ ~Euler2Solver()

libMesh::Euler2Solver::~Euler2Solver ( )

virtual

Destructor.

Definition at line 34 of file euler2_solver.C.

35 {

36 }

Member Function Documentation

◆ _general_residual()

bool libMesh::Euler2Solver::_general_residual	(	bool	request_jacobian,
		DiffContext &	context,
		ResFuncType	mass,
		ResFuncType	damping,
		ResFuncType	time_deriv,
		ResFuncType	constraint,
		ReinitFuncType	reinit,
		bool	compute_second_order_eqns
	)

protectedvirtual

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

Definition at line 99 of file euler2_solver.C.

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

 {
   unsigned int n_dofs = context.get_elem_solution().size();
 
   // Local nonlinear solution at old timestep
   DenseVector<Number> old_elem_solution(n_dofs);
   for (unsigned int i=0; i != n_dofs; ++i)
     old_elem_solution(i) =
       old_nonlinear_solution(context.get_dof_indices()[i]);
 
   // Local time derivative of solution
   context.get_elem_solution_rate() = context.get_elem_solution();
   context.get_elem_solution_rate() -= old_elem_solution;
   context.elem_solution_rate_derivative = 1 / _system.deltat;
   context.get_elem_solution_rate() *=
     context.elem_solution_rate_derivative;
 
   // Our first evaluations are at the final elem_solution
   context.elem_solution_derivative = 1.0;
 
   // If a fixed solution is requested, we'll use the elem_solution
   // at the new timestep
   // FIXME - should this be the theta solution instead?
   if (_system.use_fixed_solution)
     context.get_elem_fixed_solution() = context.get_elem_solution();
 
   context.fixed_solution_derivative = 1.0;
 
   // We need to save the old jacobian and old residual since we'll be
   // multiplying some of the new contributions by theta or 1-theta
   DenseMatrix<Number> old_elem_jacobian(n_dofs, n_dofs);
   DenseVector<Number> old_elem_residual(n_dofs);
   old_elem_residual.swap(context.get_elem_residual());
   if (request_jacobian)
     old_elem_jacobian.swap(context.get_elem_jacobian());
 
   // Local time derivative of solution
   context.get_elem_solution_rate() = context.get_elem_solution();
   context.get_elem_solution_rate() -= old_elem_solution;
   context.elem_solution_rate_derivative = 1 / _system.deltat;
   context.get_elem_solution_rate() *=
     context.elem_solution_rate_derivative;
 
   // If we are asked to compute residuals for second order variables,
   // we also populate the acceleration part so the user can use that.
   if (compute_second_order_eqns)
     this->prepare_accel(context);
 
   // Move the mesh into place first if necessary, set t = t_{n+1}
   (context.*reinit_func)(1.);
 
   // First, evaluate time derivative at the new timestep.
   // The element should already be in the proper place
   // even for a moving mesh problem.
   bool jacobian_computed =
     (_system.get_physics()->*time_deriv)(request_jacobian, context);
 
   // Next, evaluate the mass residual at the new timestep
 
   jacobian_computed = (_system.get_physics()->*mass)(jacobian_computed, context) &&
     jacobian_computed;
 
   // If we have second-order variables, we need to get damping terms
   // and the velocity equations
   if (compute_second_order_eqns)
     {
       jacobian_computed = (_system.get_physics()->*damping)(jacobian_computed, context) &&
         jacobian_computed;
 
       jacobian_computed = this->compute_second_order_eqns(jacobian_computed, context) &&
         jacobian_computed;
     }
 
   // Add the constraint term
   jacobian_computed = (_system.get_physics()->*constraint)(jacobian_computed, context) &&
     jacobian_computed;
 
   // The new solution's contribution is scaled by theta
   context.get_elem_residual() *= theta;
   context.get_elem_jacobian() *= theta;
 
   // Save the new solution's term
   DenseMatrix<Number> elem_jacobian_newterm(n_dofs, n_dofs);
   DenseVector<Number> elem_residual_newterm(n_dofs);
   elem_residual_newterm.swap(context.get_elem_residual());
   if (request_jacobian)
     elem_jacobian_newterm.swap(context.get_elem_jacobian());
 
   // Add the time-dependent term for the old solution
 
   // Make sure elem_solution is set up for elem_reinit to use
   // Move elem_->old_, old_->elem_
   context.get_elem_solution().swap(old_elem_solution);
   context.elem_solution_derivative = 0.0;
 
   // Move the mesh into place if necessary, set t = t_{n}
   (context.*reinit_func)(0.);
 
   jacobian_computed =
     (_system.get_physics()->*time_deriv)(jacobian_computed, context) &&
     jacobian_computed;
 
   // Add the mass residual term for the old solution
 
   // Evaluating the mass residual at both old and new timesteps will be
   // redundant in most problems but may be necessary for time accuracy
   // or stability in moving mesh problems or problems with user-overridden
   // mass_residual functions
 
   jacobian_computed =
     (_system.get_physics()->*mass)(jacobian_computed, context) &&
     jacobian_computed;
 
   // If we have second-order variables, we need to get damping terms
   // and the velocity equations
   if (compute_second_order_eqns)
     {
       jacobian_computed = (_system.get_physics()->*damping)(jacobian_computed, context) &&
         jacobian_computed;
 
       jacobian_computed = this->compute_second_order_eqns(jacobian_computed, context) &&
         jacobian_computed;
     }
 
   // The old solution's contribution is scaled by (1-theta)
   context.get_elem_residual() *= (1-theta);
   context.get_elem_jacobian() *= (1-theta);
 
   // Restore the elem_solution
   // Move elem_->elem_, old_->old_
   context.get_elem_solution().swap(old_elem_solution);
   context.elem_solution_derivative = 1;
 
   // Restore the elem position if necessary, set t = t_{n+1}
   (context.*reinit_func)(1.);
 
   // Add back (or restore) the old residual/jacobian
   context.get_elem_residual() += old_elem_residual;
   if (request_jacobian)
     {
       if (jacobian_computed)
         context.get_elem_jacobian() += old_elem_jacobian;
       else
         context.get_elem_jacobian().swap(old_elem_jacobian);
     }
 
   // Add the saved new-solution terms
   context.get_elem_residual() += elem_residual_newterm;
   if (jacobian_computed)
     context.get_elem_jacobian() += elem_jacobian_newterm;
 
   return jacobian_computed;
 }

◆ adjoint_advance_timestep()

void libMesh::UnsteadySolver::adjoint_advance_timestep ( )

overridevirtualinherited

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

Reimplemented in libMesh::NewmarkSolver.

Definition at line 178 of file unsteady_solver.C.

References libMesh::TimeSolver::_system, libMesh::DifferentiableSystem::deltat, libMesh::UnsteadySolver::first_adjoint_step, libMesh::System::get_dof_map(), libMesh::DofMap::get_send_list(), libMesh::System::get_vector(), libMesh::NumericVector< T >::localize(), libMesh::UnsteadySolver::old_local_nonlinear_solution, libMesh::TimeSolver::solution_history, and libMesh::System::time.

 {
   // On the first call of this function, we dont save the adjoint solution or
   // decrement the time, we just call the retrieve function below
   if (!first_adjoint_step)
     {
       // Call the store function to store the last adjoint before decrementing the time
       solution_history->store();
       // Decrement the system time
       _system.time -= _system.deltat;
     }
   else
     {
       first_adjoint_step = false;
     }
 
   // Retrieve the primal solution vectors at this time using the
   // solution_history object
   solution_history->retrieve();
 
   // Dont forget to localize the old_nonlinear_solution !
   _system.get_vector("_old_nonlinear_solution").localize
     (*old_local_nonlinear_solution,
      _system.get_dof_map().get_send_list());
 }

◆ advance_timestep()

void libMesh::UnsteadySolver::advance_timestep ( )

overridevirtualinherited

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

Reimplemented in libMesh::AdaptiveTimeSolver, and libMesh::NewmarkSolver.

Definition at line 152 of file unsteady_solver.C.

References libMesh::TimeSolver::_system, libMesh::DifferentiableSystem::deltat, libMesh::UnsteadySolver::first_solve, libMesh::System::get_dof_map(), libMesh::DofMap::get_send_list(), libMesh::System::get_vector(), libMesh::NumericVector< T >::localize(), libMesh::UnsteadySolver::old_local_nonlinear_solution, libMesh::System::solution, libMesh::TimeSolver::solution_history, and libMesh::System::time.

Referenced by libMesh::NewmarkSolver::advance_timestep(), and libMesh::UnsteadySolver::solve().

 {
   if (!first_solve)
     {
       // Store the solution, does nothing by default
       // User has to attach appropriate solution_history object for this to
       // actually store anything anywhere
       solution_history->store();
 
       _system.time += _system.deltat;
     }
 
   NumericVector<Number> & old_nonlinear_soln =
     _system.get_vector("_old_nonlinear_solution");
   NumericVector<Number> & nonlinear_solution =
     *(_system.solution);
 
   old_nonlinear_soln = nonlinear_solution;
 
   old_nonlinear_soln.localize
     (*old_local_nonlinear_solution,
      _system.get_dof_map().get_send_list());
 }

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

167 {}

◆ compute_second_order_eqns()

bool libMesh::FirstOrderUnsteadySolver::compute_second_order_eqns	(	bool	compute_jacobian,
		DiffContext &	c
	)

protectedinherited

If there are second order variables, then we need to compute their residual equations and corresponding Jacobian. The residual equation will simply be $\dot{u} - v = 0$ , where $ u $ is the second order variable add by the user and $ v $ is the variable added by the time-solver as the "velocity" variable.

Definition at line 32 of file first_order_unsteady_solver.C.

References libMesh::TimeSolver::_system, libMesh::DiffContext::get_dof_indices(), libMesh::DiffContext::get_elem_jacobian(), libMesh::DiffContext::get_elem_residual(), libMesh::DiffContext::get_elem_solution_derivative(), libMesh::DiffContext::get_elem_solution_rate_derivative(), libMesh::FEMContext::get_element_fe(), libMesh::FEMContext::get_element_qrule(), libMesh::DifferentiableSystem::get_second_order_dot_var(), libMesh::DiffContext::get_system(), libMesh::FEMContext::interior_rate(), libMesh::FEMContext::interior_value(), libMesh::DifferentiablePhysics::is_second_order_var(), libMesh::QBase::n_points(), libMesh::DiffContext::n_vars(), libMesh::Variable::type(), and libMesh::System::variable().

Referenced by libMesh::EulerSolver::_general_residual(), _general_residual(), libMesh::EulerSolver::element_residual(), element_residual(), libMesh::EulerSolver::nonlocal_residual(), and nonlocal_residual().

 {
   FEMContext & context = cast_ref<FEMContext &>(c);
 
   unsigned int n_qpoints = context.get_element_qrule().n_points();
 
   for (unsigned int var = 0; var != context.n_vars(); ++var)
     {
       if (!this->_system.is_second_order_var(var))
         continue;
 
       unsigned int dot_var = this->_system.get_second_order_dot_var(var);
 
       // We're assuming that the FE space for var and dot_var are the same
       libmesh_assert( context.get_system().variable(var).type() ==
                       context.get_system().variable(dot_var).type() );
 
       FEBase * elem_fe = nullptr;
       context.get_element_fe( var, elem_fe );
 
       const std::vector<Real> & JxW = elem_fe->get_JxW();
 
       const std::vector<std::vector<Real>> & phi = elem_fe->get_phi();
 
       const unsigned int n_dofs = cast_int<unsigned int>
         (context.get_dof_indices(dot_var).size());
 
       DenseSubVector<Number> & Fu = context.get_elem_residual(var);
       DenseSubMatrix<Number> & Kuu = context.get_elem_jacobian( var, var );
       DenseSubMatrix<Number> & Kuv = context.get_elem_jacobian( var, dot_var );
 
       for (unsigned int qp = 0; qp != n_qpoints; ++qp)
         {
           Number udot, v;
           context.interior_rate(var, qp, udot);
           context.interior_value(dot_var, qp, v);
 
           for (unsigned int i = 0; i < n_dofs; i++)
             {
               Fu(i) += JxW[qp]*(udot-v)*phi[i][qp];
 
               if (compute_jacobian)
                 {
                   Number rate_factor = JxW[qp]*context.get_elem_solution_rate_derivative()*phi[i][qp];
                   Number soln_factor = JxW[qp]*context.get_elem_solution_derivative()*phi[i][qp];
 
                   Kuu(i,i) += rate_factor*phi[i][qp];
                   Kuv(i,i) -= soln_factor*phi[i][qp];
 
                   for (unsigned int j = i+1; j < n_dofs; j++)
                     {
                       Kuu(i,j) += rate_factor*phi[j][qp];
                       Kuu(j,i) += rate_factor*phi[j][qp];
 
                       Kuv(i,j) -= soln_factor*phi[j][qp];
                       Kuv(j,i) -= soln_factor*phi[j][qp];
                     }
                 }
             }
         }
     }
 
   return compute_jacobian;
 }

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

References libMesh::TimeSolver::_diff_solver.

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

182 { return _diff_solver; }

libMesh::TimeSolver::_diff_solver

std::unique_ptr< DiffSolver > _diff_solver

Definition: time_solver.h:248

◆ disable_print_counter_info()

void libMesh::ReferenceCounter::disable_print_counter_info ( )

staticinherited

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

◆ du()

Real libMesh::UnsteadySolver::du ( const SystemNorm & norm ) const

overridevirtualinherited

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.

Implements libMesh::TimeSolver.

Definition at line 227 of file unsteady_solver.C.

References libMesh::TimeSolver::_system, libMesh::System::calculate_norm(), libMesh::System::get_vector(), and libMesh::System::solution.

 {
 
   std::unique_ptr<NumericVector<Number>> solution_copy =
     _system.solution->clone();
 
   solution_copy->add(-1., _system.get_vector("_old_nonlinear_solution"));
 
   solution_copy->close();
 
   return _system.calculate_norm(*solution_copy, norm);
 }

◆ element_residual()

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

overridevirtual

This method uses the DifferentiablePhysics' element_time_derivative() and element_constraint() to build a full residual on an element. What combination it uses will depend on theta.

Implements libMesh::TimeSolver.

Definition at line 50 of file euler2_solver.C.

References libMesh::DifferentiablePhysics::_eulerian_time_deriv(), _general_residual(), libMesh::TimeSolver::_system, libMesh::FirstOrderUnsteadySolver::compute_second_order_eqns(), libMesh::DifferentiablePhysics::damping_residual(), libMesh::DiffContext::elem_reinit(), libMesh::DifferentiablePhysics::element_constraint(), libMesh::DifferentiableSystem::get_physics(), libMesh::DifferentiablePhysics::get_second_order_vars(), and libMesh::DifferentiablePhysics::mass_residual().

 {
   bool compute_second_order_eqns = !this->_system.get_physics()->get_second_order_vars().empty();
 
   return this->_general_residual(request_jacobian,
                                  context,
                                  &DifferentiablePhysics::mass_residual,
                                  &DifferentiablePhysics::damping_residual,
                                  &DifferentiablePhysics::_eulerian_time_deriv,
                                  &DifferentiablePhysics::element_constraint,
                                  &DiffContext::elem_reinit,
                                  compute_second_order_eqns);
 }

◆ 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 100 of file reference_counter.C.

References libMesh::ReferenceCounter::_enable_print_counter.

 {
   _enable_print_counter = true;
   return;
 }

◆ error_order()

Real libMesh::Euler2Solver::error_order ( ) const

overridevirtual

Error convergence order: 2 for Crank-Nicolson, 1 otherwise

Implements libMesh::UnsteadySolver.

Definition at line 40 of file euler2_solver.C.

References theta.

 {
   if (theta == 0.5)
     return 2.;
   return 1.;
 }

◆ 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 & pr : _counts)
     {
       const std::string name(pr.first);
       const unsigned int creations    = pr.second.first;
       const unsigned int destructions = pr.second.second;
 
       oss << "| " << name << " reference count information:\n"
           << "|  Creations:    " << creations    << '\n'
           << "|  Destructions: " << destructions << '\n';
     }
 
   oss << " ---------------------------------------------------------------------------- \n";
 
   return oss.str();
 
 #else
 
   return "";
 
 #endif
 }

◆ increment_constructor_count()

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

inlineprotectedinherited

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

Definition at line 181 of file reference_counter.h.

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

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

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

◆ increment_destructor_count()

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

inlineprotectedinherited

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

Definition at line 194 of file reference_counter.h.

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

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

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

◆ init()

void libMesh::UnsteadySolver::init ( )

overridevirtualinherited

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

Reimplemented from libMesh::TimeSolver.

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

Definition at line 46 of file unsteady_solver.C.

References libMesh::TimeSolver::_system, libMesh::System::add_vector(), and libMesh::TimeSolver::init().

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

 {
   TimeSolver::init();
 
   _system.add_vector("_old_nonlinear_solution");
 }

◆ init_data()

void libMesh::UnsteadySolver::init_data ( )

overridevirtualinherited

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

Reimplemented from libMesh::TimeSolver.

Reimplemented in libMesh::SecondOrderUnsteadySolver.

Definition at line 55 of file unsteady_solver.C.

References libMesh::TimeSolver::_system, libMesh::System::get_dof_map(), libMesh::DofMap::get_send_list(), libMesh::GHOSTED, libMesh::TimeSolver::init_data(), libMesh::System::n_dofs(), libMesh::System::n_local_dofs(), libMesh::UnsteadySolver::old_local_nonlinear_solution, and libMesh::SERIAL.

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

 {
   TimeSolver::init_data();
 
 #ifdef LIBMESH_ENABLE_GHOSTED
   old_local_nonlinear_solution->init (_system.n_dofs(), _system.n_local_dofs(),
                                       _system.get_dof_map().get_send_list(), false,
                                       GHOSTED);
 #else
   old_local_nonlinear_solution->init (_system.n_dofs(), false, SERIAL);
 #endif
 }

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

References libMesh::TimeSolver::_is_adjoint.

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

234 { return _is_adjoint; }

libMesh::TimeSolver::_is_adjoint

bool _is_adjoint

Definition: time_solver.h:281

◆ is_steady()

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

inlineoverridevirtualinherited

This is not a steady-state solver.

Implements libMesh::TimeSolver.

Definition at line 154 of file unsteady_solver.h.

154 { return false; }

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

References libMesh::TimeSolver::_linear_solver.

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

187 { return _linear_solver; }

libMesh::TimeSolver::_linear_solver

std::unique_ptr< LinearSolver< Number > > _linear_solver

Definition: time_solver.h:253

◆ n_objects()

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

inlinestaticinherited

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

Definition at line 83 of file reference_counter.h.

References libMesh::ReferenceCounter::_n_objects.

84 { return _n_objects; }

libMesh::ReferenceCounter::_n_objects

static Threads::atomic< unsigned int > _n_objects

Definition: reference_counter.h:130

◆ nonlocal_residual()

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

overridevirtual

This method uses the DifferentiablePhysics' nonlocal_time_derivative() and nonlocal_constraint() to build a full residual for non-local terms. What combination it uses will depend on theta.

Implements libMesh::TimeSolver.

Definition at line 82 of file euler2_solver.C.

References _general_residual(), libMesh::TimeSolver::_system, libMesh::FirstOrderUnsteadySolver::compute_second_order_eqns(), libMesh::DifferentiableSystem::have_second_order_scalar_vars(), libMesh::DifferentiablePhysics::nonlocal_constraint(), libMesh::DifferentiablePhysics::nonlocal_damping_residual(), libMesh::DifferentiablePhysics::nonlocal_mass_residual(), libMesh::DiffContext::nonlocal_reinit(), and libMesh::DifferentiablePhysics::nonlocal_time_derivative().

 {
   bool compute_second_order_eqns = this->_system.have_second_order_scalar_vars();
 
   return this->_general_residual(request_jacobian,
                                  context,
                                  &DifferentiablePhysics::nonlocal_mass_residual,
                                  &DifferentiablePhysics::nonlocal_damping_residual,
                                  &DifferentiablePhysics::nonlocal_time_derivative,
                                  &DifferentiablePhysics::nonlocal_constraint,
                                  &DiffContext::nonlocal_reinit,
                                  compute_second_order_eqns);
 }

◆ old_nonlinear_solution()

Number libMesh::UnsteadySolver::old_nonlinear_solution ( const dof_id_type global_dof_number ) const

inherited

Returns: The old nonlinear solution for the specified global DOF.

Definition at line 216 of file unsteady_solver.C.

References libMesh::TimeSolver::_system, libMesh::System::get_dof_map(), libMesh::DofMap::n_dofs(), and libMesh::UnsteadySolver::old_local_nonlinear_solution.

Referenced by libMesh::EulerSolver::_general_residual(), _general_residual(), and libMesh::NewmarkSolver::_general_residual().

 {
   libmesh_assert_less (global_dof_number, _system.get_dof_map().n_dofs());
   libmesh_assert_less (global_dof_number, old_local_nonlinear_solution->size());
 
   return (*old_local_nonlinear_solution)(global_dof_number);
 }

◆ prepare_accel()

void libMesh::FirstOrderUnsteadySolver::prepare_accel ( DiffContext & context )

protectedinherited

If there are second order variables in the system, then we also prepare the accel for those variables so the user can treat them as such.

Definition at line 25 of file first_order_unsteady_solver.C.

References libMesh::DiffContext::elem_solution_accel_derivative, libMesh::DiffContext::get_elem_solution_accel(), libMesh::DiffContext::get_elem_solution_rate(), and libMesh::DiffContext::get_elem_solution_rate_derivative().

Referenced by libMesh::EulerSolver::_general_residual(), and _general_residual().

 {
   context.get_elem_solution_accel() = context.get_elem_solution_rate();
 
   context.elem_solution_accel_derivative = context.get_elem_solution_rate_derivative();
 }

◆ print_info()

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

staticinherited

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

Definition at line 87 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();
 }

◆ reinit()

void libMesh::UnsteadySolver::reinit ( )

overridevirtualinherited

The reinitialization function. This method is used to resize internal data vectors after a mesh change.

Reimplemented from libMesh::TimeSolver.

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

Definition at line 70 of file unsteady_solver.C.

References libMesh::TimeSolver::_system, libMesh::System::get_dof_map(), libMesh::DofMap::get_send_list(), libMesh::System::get_vector(), libMesh::GHOSTED, libMesh::NumericVector< T >::localize(), libMesh::System::n_dofs(), libMesh::System::n_local_dofs(), libMesh::UnsteadySolver::old_local_nonlinear_solution, libMesh::TimeSolver::reinit(), and libMesh::SERIAL.

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

 {
   TimeSolver::reinit();
 
 #ifdef LIBMESH_ENABLE_GHOSTED
   old_local_nonlinear_solution->init (_system.n_dofs(), _system.n_local_dofs(),
                                       _system.get_dof_map().get_send_list(), false,
                                       GHOSTED);
 #else
   old_local_nonlinear_solution->init (_system.n_dofs(), false, SERIAL);
 #endif
 
   // localize the old solution
   NumericVector<Number> & old_nonlinear_soln =
     _system.get_vector("_old_nonlinear_solution");
 
   old_nonlinear_soln.localize
     (*old_local_nonlinear_solution,
      _system.get_dof_map().get_send_list());
 }

◆ retrieve_timestep()

void libMesh::UnsteadySolver::retrieve_timestep ( )

overridevirtualinherited

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

Reimplemented from libMesh::TimeSolver.

Reimplemented in libMesh::SecondOrderUnsteadySolver.

Definition at line 204 of file unsteady_solver.C.

References libMesh::TimeSolver::_system, libMesh::System::get_dof_map(), libMesh::DofMap::get_send_list(), libMesh::System::get_vector(), libMesh::NumericVector< T >::localize(), libMesh::UnsteadySolver::old_local_nonlinear_solution, and libMesh::TimeSolver::solution_history.

 {
   // Retrieve all the stored vectors at the current time
   solution_history->retrieve();
 
   // Dont forget to localize the old_nonlinear_solution !
   _system.get_vector("_old_nonlinear_solution").localize
     (*old_local_nonlinear_solution,
      _system.get_dof_map().get_send_list());
 }

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

References libMesh::TimeSolver::_is_adjoint.

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

241 { _is_adjoint = _is_adjoint_value; }

libMesh::TimeSolver::_is_adjoint

bool _is_adjoint

Definition: time_solver.h:281

◆ 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 97 of file time_solver.C.

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

 {
   solution_history = _solution_history.clone();
 }

◆ side_residual()

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

overridevirtual

This method uses the DifferentiablePhysics' side_time_derivative() and side_constraint() to build a full residual on an element's side. What combination it uses will depend on theta.

Implements libMesh::TimeSolver.

Definition at line 67 of file euler2_solver.C.

References _general_residual(), libMesh::DiffContext::elem_side_reinit(), libMesh::DifferentiablePhysics::side_constraint(), libMesh::DifferentiablePhysics::side_damping_residual(), libMesh::DifferentiablePhysics::side_mass_residual(), and libMesh::DifferentiablePhysics::side_time_derivative().

 {
   return this->_general_residual(request_jacobian,
                                  context,
                                  &DifferentiablePhysics::side_mass_residual,
                                  &DifferentiablePhysics::side_damping_residual,
                                  &DifferentiablePhysics::side_time_derivative,
                                  &DifferentiablePhysics::side_constraint,
                                  &DiffContext::elem_side_reinit,
                                  false);
 }

◆ solve()

void libMesh::UnsteadySolver::solve ( )

overridevirtualinherited

This method solves for the solution at the next timestep. Usually we will only need to solve one (non)linear system per timestep, but more complex subclasses may override this.

Reimplemented from libMesh::TimeSolver.

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

Definition at line 93 of file unsteady_solver.C.

References libMesh::TimeSolver::_diff_solver, libMesh::TimeSolver::_system, libMesh::UnsteadySolver::advance_timestep(), libMesh::DifferentiableSystem::deltat, libMesh::DiffSolver::DIVERGED_BACKTRACKING_FAILURE, libMesh::DiffSolver::DIVERGED_MAX_NONLINEAR_ITERATIONS, libMesh::UnsteadySolver::first_solve, libMesh::out, libMesh::TimeSolver::quiet, and libMesh::TimeSolver::reduce_deltat_on_diffsolver_failure.

Referenced by libMesh::NewmarkSolver::solve().

 {
   if (first_solve)
     {
       advance_timestep();
       first_solve = false;
     }
 
   unsigned int solve_result = _diff_solver->solve();
 
   // If we requested the UnsteadySolver to attempt reducing dt after a
   // failed DiffSolver solve, check the results of the solve now.
   if (reduce_deltat_on_diffsolver_failure)
     {
       bool backtracking_failed =
         solve_result & DiffSolver::DIVERGED_BACKTRACKING_FAILURE;
 
       bool max_iterations =
         solve_result & DiffSolver::DIVERGED_MAX_NONLINEAR_ITERATIONS;
 
       if (backtracking_failed || max_iterations)
         {
           // Cut timestep in half
           for (unsigned int nr=0; nr<reduce_deltat_on_diffsolver_failure; ++nr)
             {
               _system.deltat *= 0.5;
               libMesh::out << "Newton backtracking failed.  Trying with smaller timestep, dt="
                            << _system.deltat << std::endl;
 
               solve_result = _diff_solver->solve();
 
               // Check solve results with reduced timestep
               bool backtracking_still_failed =
                 solve_result & DiffSolver::DIVERGED_BACKTRACKING_FAILURE;
 
               bool backtracking_max_iterations =
                 solve_result & DiffSolver::DIVERGED_MAX_NONLINEAR_ITERATIONS;
 
               if (!backtracking_still_failed && !backtracking_max_iterations)
                 {
                   if (!quiet)
                     libMesh::out << "Reduced dt solve succeeded." << std::endl;
                   return;
                 }
             }
 
           // If we made it here, we still couldn't converge the solve after
           // reducing deltat
           libMesh::out << "DiffSolver::solve() did not succeed after "
                        << reduce_deltat_on_diffsolver_failure
                        << " attempts." << std::endl;
           libmesh_convergence_failure();
 
         } // end if (backtracking_failed || max_iterations)
     } // end if (reduce_deltat_on_diffsolver_failure)
 }

◆ system() [1/2]

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

inlineinherited

Returns: A constant reference to the system we are solving.

Definition at line 172 of file time_solver.h.

References libMesh::TimeSolver::_system.

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

172 { return _system; }

libMesh::TimeSolver::_system

sys_type & _system

Definition: time_solver.h:258

◆ system() [2/2]

sys_type& libMesh::TimeSolver::system ( )

inlineinherited

Returns: A writable reference to the system we are solving.

Definition at line 177 of file time_solver.h.

References libMesh::TimeSolver::_system.

177 { return _system; }

libMesh::TimeSolver::_system

sys_type & _system

Definition: time_solver.h:258

◆ time_order()

virtual unsigned int libMesh::FirstOrderUnsteadySolver::time_order ( ) const

inlineoverridevirtualinherited

Returns: The maximum order of time derivatives for which the UnsteadySolver subclass is capable of handling.

For example, EulerSolver will have time_order() = 1 and NewmarkSolver will have time_order() = 2.

Implements libMesh::UnsteadySolver.

Definition at line 90 of file first_order_unsteady_solver.h.

91 { return 1; }

Member Data Documentation

◆ _counts

ReferenceCounter::Counts libMesh::ReferenceCounter::_counts

staticprotectedinherited

Actually holds the data.

Definition at line 122 of file reference_counter.h.

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

◆ _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 248 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 141 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 253 of file time_solver.h.

Referenced by libMesh::TimeSolver::linear_solver().

◆ _mutex

Threads::spin_mutex libMesh::ReferenceCounter::_mutex

staticprotectedinherited

Mutual exclusion object to enable thread-safe reference counting.

Definition at line 135 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 130 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 258 of file time_solver.h.

◆ first_adjoint_step

bool libMesh::UnsteadySolver::first_adjoint_step

protectedinherited

A bool that will be true the first time adjoint_advance_timestep() is called, (when the primal solution is to be used to set adjoint boundary conditions) and false thereafter

Definition at line 168 of file unsteady_solver.h.

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

◆ first_solve

bool libMesh::UnsteadySolver::first_solve

protectedinherited

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

Definition at line 162 of file unsteady_solver.h.

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

◆ old_local_nonlinear_solution

std::unique_ptr<NumericVector<Number> > libMesh::UnsteadySolver::old_local_nonlinear_solution

inherited

Serial vector of _system.get_vector("_old_nonlinear_solution")

Definition at line 138 of file unsteady_solver.h.

Referenced by libMesh::AdaptiveTimeSolver::AdaptiveTimeSolver(), libMesh::UnsteadySolver::adjoint_advance_timestep(), libMesh::UnsteadySolver::advance_timestep(), libMesh::AdaptiveTimeSolver::init(), libMesh::UnsteadySolver::init_data(), libMesh::UnsteadySolver::old_nonlinear_solution(), libMesh::UnsteadySolver::reinit(), libMesh::UnsteadySolver::retrieve_timestep(), and libMesh::AdaptiveTimeSolver::~AdaptiveTimeSolver().

◆ quiet

bool libMesh::TimeSolver::quiet

inherited

Print extra debugging information if quiet == false.

Definition at line 192 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 221 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 265 of file time_solver.h.

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

◆ theta

Real libMesh::Euler2Solver::theta

The value for the theta method to employ: 1.0 corresponds to backwards Euler, 0.0 corresponds to forwards Euler, 0.5 corresponds to a Crank-Nicolson-like scheme.

Definition at line 105 of file euler2_solver.h.

Referenced by _general_residual(), and error_order().

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

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Types

Protected Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

Member Typedef Documentation

◆ Counts

◆ Parent

◆ ReinitFuncType

◆ ResFuncType

◆ sys_type

Constructor & Destructor Documentation

◆ Euler2Solver()

◆ ~Euler2Solver()

Member Function Documentation

◆ _general_residual()

◆ adjoint_advance_timestep()

◆ advance_timestep()

◆ before_timestep()

◆ compute_second_order_eqns()

◆ diff_solver()

◆ disable_print_counter_info()

◆ du()

◆ element_residual()

◆ enable_print_counter_info()

◆ error_order()

◆ get_info()

◆ increment_constructor_count()

◆ increment_destructor_count()

◆ init()

◆ init_data()

◆ is_adjoint()

◆ is_steady()

◆ linear_solver()

◆ n_objects()

◆ nonlocal_residual()

◆ old_nonlinear_solution()

◆ prepare_accel()

◆ print_info()

◆ reinit()

◆ retrieve_timestep()

◆ set_is_adjoint()

◆ set_solution_history()

◆ side_residual()

◆ solve()

◆ system() [1/2]

◆ system() [2/2]

◆ time_order()

Member Data Documentation

◆ _counts

◆ _diff_solver

◆ _enable_print_counter

◆ _linear_solver

◆ _mutex

◆ _n_objects

◆ _system

◆ first_adjoint_step

◆ first_solve

◆ old_local_nonlinear_solution

◆ quiet

◆ reduce_deltat_on_diffsolver_failure

◆ solution_history

◆ theta