libMesh
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Protected Types | Protected Member Functions | Protected Attributes | Static Protected Attributes | Private Attributes | List of all members
libMesh::Euler2Solver Class Reference

This class defines a theta-method (defaulting to Backward Euler with theta = 1.0) solver to handle time integration of DifferentiableSystems. More...

#include <euler2_solver.h>

Inheritance diagram for libMesh::Euler2Solver:
[legend]

Public Types

typedef FirstOrderUnsteadySolver Parent
 The parent class.
 
typedef DifferentiableSystem sys_type
 The type of system.
 

Public Member Functions

 Euler2Solver (sys_type &s)
 Constructor.
 
virtual ~Euler2Solver ()
 Destructor.
 
virtual Real error_order () const override
 Error convergence order: 2 for Crank-Nicolson, 1 otherwise.
 
virtual void integrate_qoi_timestep () override
 A method to integrate the system::QoI functionals.
 
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.
 
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 on an element.
 
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 on an element's side.
 
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 for non-local terms.
 
virtual unsigned int time_order () const override
 
virtual void init () override
 The initialization function.
 
virtual void init_adjoints () override
 Add adjoint vectors and old_adjoint_vectors as per the indices of QoISet.
 
virtual void init_data () override
 The data initialization function.
 
virtual void reinit () override
 The reinitialization function.
 
virtual void solve () override
 This method solves for the solution at the next timestep.
 
virtual void advance_timestep () override
 This method advances the solution to the next timestep, after a solve() has been performed.
 
void update ()
 
virtual std::pair< unsigned int, Realadjoint_solve (const QoISet &qoi_indices) override
 This method solves for the adjoint solution at the next adjoint timestep (or a steady state adjoint solve)
 
virtual void adjoint_advance_timestep () override
 This method advances the adjoint solution to the previous timestep, after an adjoint_solve() has been performed.
 
virtual void retrieve_timestep () override
 This method retrieves all the stored solutions at the current system.time.
 
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.
 
Number old_nonlinear_solution (const dof_id_type global_dof_number) const
 
virtual Real du (const SystemNorm &norm) const override
 Computes the size of ||u^{n+1} - u^{n}|| in some norm.
 
virtual bool is_steady () const override
 This is not a steady-state solver.
 
void set_first_adjoint_step (bool first_adjoint_step_setting)
 A setter for the first_adjoint_step boolean.
 
void set_first_solve (bool first_solve_setting)
 
virtual void before_timestep ()
 This method is for subclasses or users to override to do arbitrary processing between timesteps.
 
const sys_typesystem () const
 
sys_typesystem ()
 
virtual std::unique_ptr< DiffSolver > & diff_solver ()
 An implicit linear or nonlinear solver to use at each timestep.
 
virtual std::unique_ptr< LinearSolver< Number > > & linear_solver ()
 An implicit linear solver to use for adjoint and sensitivity problems.
 
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.
 
SolutionHistoryget_solution_history ()
 A getter function that returns a reference to the solution history object owned by TimeSolver.
 
bool is_adjoint () const
 Accessor for querying whether we need to do a primal or adjoint solve.
 
void set_is_adjoint (bool _is_adjoint_value)
 Accessor for setting whether we need to do a primal or adjoint solve.
 
virtual Real last_completed_timestep_size ()
 Returns system.deltat if fixed timestep solver is used, the complete timestep size (sum of all substeps) if the adaptive time solver is used.
 

Static Public Member Functions

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

Public Attributes

Real 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.
 
std::shared_ptr< NumericVector< Number > > old_local_nonlinear_solution
 Serial vector of _system.get_vector("_old_nonlinear_solution") This is a shared_ptr so that it can be shared between different derived class instances, as in e.g.
 
bool quiet
 Print extra debugging information if quiet == false.
 
unsigned int reduce_deltat_on_diffsolver_failure
 This value (which defaults to zero) is the number of times the TimeSolver is allowed to halve deltat and let the DiffSolver repeat the latest failed solve with a reduced timestep.
 

Protected Types

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

Protected Member Functions

virtual bool _general_residual (bool request_jacobian, DiffContext &, ResFuncType mass, ResFuncType damping, ResFuncType time_deriv, ResFuncType constraint, ReinitFuncType reinit, bool compute_second_order_eqns)
 This method is the underlying implementation of the public residual methods.
 
void prepare_accel (DiffContext &context)
 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.
 
bool compute_second_order_eqns (bool compute_jacobian, DiffContext &c)
 If there are second order variables, then we need to compute their residual equations and corresponding Jacobian.
 
void increment_constructor_count (const std::string &name) noexcept
 Increments the construction counter.
 
void increment_destructor_count (const std::string &name) noexcept
 Increments the destruction counter.
 

Protected Attributes

bool first_solve
 A bool that will be true the first time solve() is called, and false thereafter.
 
bool first_adjoint_step
 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.
 
std::vector< std::unique_ptr< NumericVector< Number > > > old_adjoints
 A vector of pointers to vectors holding the adjoint solution at the last time step.
 
Real last_step_deltat
 We will need to move the system.time around to ensure that residuals are built with the right deltat and the right time.
 
Real next_step_deltat
 
std::unique_ptr< DiffSolver_diff_solver
 An implicit linear or nonlinear solver to use at each timestep.
 
std::unique_ptr< LinearSolver< Number > > _linear_solver
 An implicit linear solver to use for adjoint problems.
 
sys_type_system
 A reference to the system we are solving.
 
std::unique_ptr< SolutionHistorysolution_history
 A std::unique_ptr to a SolutionHistory object.
 
Real last_deltat
 The deltat for the last completed timestep before the current one.
 

Static Protected Attributes

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

Private Attributes

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

Detailed Description

This 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 119 of file reference_counter.h.

◆ 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 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

The type of system.

Definition at line 69 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 33 of file euler2_solver.C.

35{
36}
Real theta
The value for the theta method to employ: 1.0 corresponds to backwards Euler, 0.0 corresponds to forw...

◆ ~Euler2Solver()

libMesh::Euler2Solver::~Euler2Solver ( )
virtualdefault

Destructor.

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 103 of file euler2_solver.C.

111{
112 unsigned int n_dofs = context.get_elem_solution().size();
113
114 // Local nonlinear solution at old timestep
115 DenseVector<Number> old_elem_solution(n_dofs);
116 for (unsigned int i=0; i != n_dofs; ++i)
117 old_elem_solution(i) =
118 old_nonlinear_solution(context.get_dof_indices()[i]);
119
120 // Local time derivative of solution
121 context.get_elem_solution_rate() = context.get_elem_solution();
122 context.get_elem_solution_rate() -= old_elem_solution;
123 context.elem_solution_rate_derivative = 1 / _system.deltat;
124 context.get_elem_solution_rate() *=
125 context.elem_solution_rate_derivative;
126
127 // Our first evaluations are at the final elem_solution
128 context.elem_solution_derivative = 1.0;
129
130 // If a fixed solution is requested, we'll use the elem_solution
131 // at the new timestep
132 // FIXME - should this be the theta solution instead?
134 context.get_elem_fixed_solution() = context.get_elem_solution();
135
136 context.fixed_solution_derivative = 1.0;
137
138 // We need to save the old jacobian and old residual since we'll be
139 // multiplying some of the new contributions by theta or 1-theta
140 DenseMatrix<Number> old_elem_jacobian(n_dofs, n_dofs);
141 DenseVector<Number> old_elem_residual(n_dofs);
142 old_elem_residual.swap(context.get_elem_residual());
143 if (request_jacobian)
144 old_elem_jacobian.swap(context.get_elem_jacobian());
145
146 // Local time derivative of solution
147 context.get_elem_solution_rate() = context.get_elem_solution();
148 context.get_elem_solution_rate() -= old_elem_solution;
149 context.elem_solution_rate_derivative = 1 / _system.deltat;
150 context.get_elem_solution_rate() *=
151 context.elem_solution_rate_derivative;
152
153 // If we are asked to compute residuals for second order variables,
154 // we also populate the acceleration part so the user can use that.
156 this->prepare_accel(context);
157
158 // Move the mesh into place first if necessary, set t = t_{n+1}
159 (context.*reinit_func)(1.);
160
161 // First, evaluate time derivative at the new timestep.
162 // The element should already be in the proper place
163 // even for a moving mesh problem.
164 bool jacobian_computed =
165 (_system.get_physics()->*time_deriv)(request_jacobian, context);
166
167 // Next, evaluate the mass residual at the new timestep
168
169 jacobian_computed = (_system.get_physics()->*mass)(jacobian_computed, context) &&
170 jacobian_computed;
171
172 // If we have second-order variables, we need to get damping terms
173 // and the velocity equations
175 {
176 jacobian_computed = (_system.get_physics()->*damping)(jacobian_computed, context) &&
177 jacobian_computed;
178
179 jacobian_computed = this->compute_second_order_eqns(jacobian_computed, context) &&
180 jacobian_computed;
181 }
182
183 // Add the constraint term
184 jacobian_computed = (_system.get_physics()->*constraint)(jacobian_computed, context) &&
185 jacobian_computed;
186
187 // The new solution's contribution is scaled by theta
188 context.get_elem_residual() *= theta;
189 context.get_elem_jacobian() *= theta;
190
191 // Save the new solution's term
192 DenseMatrix<Number> elem_jacobian_newterm(n_dofs, n_dofs);
193 DenseVector<Number> elem_residual_newterm(n_dofs);
194 elem_residual_newterm.swap(context.get_elem_residual());
195 if (request_jacobian)
196 elem_jacobian_newterm.swap(context.get_elem_jacobian());
197
198 // Add the time-dependent term for the old solution
199
200 // Make sure elem_solution is set up for elem_reinit to use
201 // Move elem_->old_, old_->elem_
202 context.get_elem_solution().swap(old_elem_solution);
203 context.elem_solution_derivative = 0.0;
204
205 // Move the mesh into place if necessary, set t = t_{n}
206 (context.*reinit_func)(0.);
207
208 jacobian_computed =
209 (_system.get_physics()->*time_deriv)(jacobian_computed, context) &&
210 jacobian_computed;
211
212 // Add the mass residual term for the old solution
213
214 // Evaluating the mass residual at both old and new timesteps will be
215 // redundant in most problems but may be necessary for time accuracy
216 // or stability in moving mesh problems or problems with user-overridden
217 // mass_residual functions
218
219 jacobian_computed =
220 (_system.get_physics()->*mass)(jacobian_computed, context) &&
221 jacobian_computed;
222
223 // If we have second-order variables, we need to get damping terms
224 // and the velocity equations
226 {
227 jacobian_computed = (_system.get_physics()->*damping)(jacobian_computed, context) &&
228 jacobian_computed;
229
230 jacobian_computed = this->compute_second_order_eqns(jacobian_computed, context) &&
231 jacobian_computed;
232 }
233
234 // The old solution's contribution is scaled by (1-theta)
235 context.get_elem_residual() *= (1-theta);
236 context.get_elem_jacobian() *= (1-theta);
237
238 // Restore the elem_solution
239 // Move elem_->elem_, old_->old_
240 context.get_elem_solution().swap(old_elem_solution);
241 context.elem_solution_derivative = 1;
242
243 // Restore the elem position if necessary, set t = t_{n+1}
244 (context.*reinit_func)(1.);
245
246 // Add back (or restore) the old residual/jacobian
247 context.get_elem_residual() += old_elem_residual;
248 if (request_jacobian)
249 {
250 if (jacobian_computed)
251 context.get_elem_jacobian() += old_elem_jacobian;
252 else
253 context.get_elem_jacobian().swap(old_elem_jacobian);
254 }
255
256 // Add the saved new-solution terms
257 context.get_elem_residual() += elem_residual_newterm;
258 if (jacobian_computed)
259 context.get_elem_jacobian() += elem_jacobian_newterm;
260
261 return jacobian_computed;
262}
const DifferentiablePhysics * get_physics() const
Real deltat
For time-dependent problems, this is the amount delta t to advance the solution in time.
bool compute_second_order_eqns(bool compute_jacobian, DiffContext &c)
If there are second order variables, then we need to compute their residual equations and correspondi...
void prepare_accel(DiffContext &context)
If there are second order variables in the system, then we also prepare the accel for those variables...
bool use_fixed_solution
A boolean to be set to true by systems using elem_fixed_solution, for optional use by e....
Definition system.h:1625
sys_type & _system
A reference to the system we are solving.
Number old_nonlinear_solution(const dof_id_type global_dof_number) const

References libMesh::TimeSolver::_system, libMesh::FirstOrderUnsteadySolver::compute_second_order_eqns(), libMesh::DifferentiableSystem::deltat, libMesh::DiffContext::elem_solution_derivative, libMesh::DiffContext::elem_solution_rate_derivative, libMesh::DiffContext::fixed_solution_derivative, libMesh::DiffContext::get_dof_indices(), libMesh::DiffContext::get_elem_fixed_solution(), libMesh::DiffContext::get_elem_jacobian(), libMesh::DiffContext::get_elem_residual(), libMesh::DiffContext::get_elem_solution(), libMesh::DiffContext::get_elem_solution_rate(), libMesh::DifferentiableSystem::get_physics(), libMesh::UnsteadySolver::old_nonlinear_solution(), libMesh::FirstOrderUnsteadySolver::prepare_accel(), libMesh::DenseVector< T >::size(), libMesh::DenseMatrix< T >::swap(), libMesh::DenseVector< T >::swap(), theta, and libMesh::System::use_fixed_solution.

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

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

Definition at line 239 of file unsteady_solver.C.

240{
241 // Call the store function to store the adjoint we have computed (or
242 // for first_adjoint_step, the adjoint initial condition) in this
243 // time step for the time instance.
244 solution_history->store(true, _system.time);
245
246 // Before moving to the next time instant, copy over the current adjoint solutions into _old_adjoint_solutions
247 for(auto i : make_range(_system.n_qois()))
248 {
249 std::string old_adjoint_solution_name = "_old_adjoint_solution";
250 old_adjoint_solution_name+= std::to_string(i);
251 NumericVector<Number> & old_adjoint_solution_i = _system.get_vector(old_adjoint_solution_name);
252 NumericVector<Number> & adjoint_solution_i = _system.get_adjoint_solution(i);
253 old_adjoint_solution_i = adjoint_solution_i;
254 }
255
257
258 // Retrieve the primal solution vectors at this new (or for
259 // first_adjoint_step, initial) time instance. These provide the
260 // data to solve the adjoint problem for the next time instance.
261 solution_history->retrieve(true, _system.time);
262
263 // Dont forget to localize the old_nonlinear_solution !
264 _system.get_vector("_old_nonlinear_solution").localize
267}
const std::vector< dof_id_type > & get_send_list() const
Definition dof_map.h:533
virtual void localize(std::vector< T > &v_local) const =0
Creates a copy of the global vector in the local vector v_local.
Real time
For time-dependent problems, this is the time t at the beginning of the current timestep.
Definition system.h:1677
const DofMap & get_dof_map() const
Definition system.h:2417
NumericVector< Number > & get_adjoint_solution(unsigned int i=0)
Definition system.C:1232
const NumericVector< Number > & get_vector(std::string_view vec_name) const
Definition system.C:931
std::unique_ptr< SolutionHistory > solution_history
A std::unique_ptr to a SolutionHistory object.
std::shared_ptr< NumericVector< Number > > old_local_nonlinear_solution
Serial vector of _system.get_vector("_old_nonlinear_solution") This is a shared_ptr so that it can be...
template class LIBMESH_EXPORT NumericVector< Number >
IntRange< T > make_range(T beg, T end)
The 2-parameter make_range() helper function returns an IntRange<T> when both input parameters are of...
Definition int_range.h:176

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

◆ adjoint_solve()

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

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

Reimplemented from libMesh::TimeSolver.

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

Definition at line 228 of file unsteady_solver.C.

229{
230 std::pair<unsigned int, Real> adjoint_output = _system.ImplicitSystem::adjoint_solve(qoi_indices);
231
232 // Record the deltat we used for this adjoint timestep. This was determined completely
233 // by SolutionHistory::retrieve methods. The adjoint_solve methods should never change deltat.
235
236 return adjoint_output;
237}
Real last_deltat
The deltat for the last completed timestep before the current one.

References libMesh::TimeSolver::_system, libMesh::DifferentiableSystem::deltat, and libMesh::TimeSolver::last_deltat.

◆ 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 192 of file unsteady_solver.C.

193{
194 // The first access of advance_timestep happens via solve, not user code
195 // It is used here to store any initial conditions data
196 if (!first_solve)
197 {
198 // We call advance_timestep in user code after solve, so any solutions
199 // we will be storing will be for the next time instance
201 }
202 else
203 {
204 // We are here because of a call to advance_timestep that happens
205 // via solve, the very first solve. All we are doing here is storing
206 // the initial condition. The actual solution computed via this solve
207 // will be stored when we call advance_timestep in the user's timestep loop
208 first_solve = false;
209 }
210
211 // If the user has attached a memory or file solution history object
212 // to the solver, this will store the current solution indexed with
213 // the current time
214 solution_history->store(false, _system.time);
215
216 NumericVector<Number> & old_nonlinear_soln =
217 _system.get_vector("_old_nonlinear_solution");
218 NumericVector<Number> & nonlinear_solution =
219 *(_system.solution);
220
221 old_nonlinear_soln = nonlinear_solution;
222
223 old_nonlinear_soln.localize
226}
std::unique_ptr< NumericVector< Number > > solution
Data structure to hold solution values.
Definition system.h:1655
bool first_solve
A bool that will be true the first time solve() is called, and false thereafter.

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

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

205{}

◆ 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 33 of file first_order_unsteady_solver.C.

34{
35 FEMContext & context = cast_ref<FEMContext &>(c);
36
37 unsigned int n_qpoints = context.get_element_qrule().n_points();
38
39 for (auto var : make_range(context.n_vars()))
40 {
41 if (!this->_system.is_second_order_var(var))
42 continue;
43
44 unsigned int dot_var = this->_system.get_second_order_dot_var(var);
45
46 // We're assuming that the FE space for var and dot_var are the same
47 libmesh_assert( context.get_system().variable(var).type() ==
48 context.get_system().variable(dot_var).type() );
49
50 FEBase * elem_fe = nullptr;
51 context.get_element_fe( var, elem_fe );
52
53 const std::vector<Real> & JxW = elem_fe->get_JxW();
54
55 const std::vector<std::vector<Real>> & phi = elem_fe->get_phi();
56
57 const unsigned int n_dofs = cast_int<unsigned int>
58 (context.get_dof_indices(dot_var).size());
59
60 DenseSubVector<Number> & Fu = context.get_elem_residual(var);
61 DenseSubMatrix<Number> & Kuu = context.get_elem_jacobian( var, var );
62 DenseSubMatrix<Number> & Kuv = context.get_elem_jacobian( var, dot_var );
63
64 for (unsigned int qp = 0; qp != n_qpoints; ++qp)
65 {
66 Number udot, v;
67 context.interior_rate(var, qp, udot);
68 context.interior_value(dot_var, qp, v);
69
70 for (unsigned int i = 0; i < n_dofs; i++)
71 {
72 Fu(i) += JxW[qp]*(udot-v)*phi[i][qp];
73
75 {
76 Number rate_factor = JxW[qp]*context.get_elem_solution_rate_derivative()*phi[i][qp];
77 Number soln_factor = JxW[qp]*context.get_elem_solution_derivative()*phi[i][qp];
78
79 Kuu(i,i) += rate_factor*phi[i][qp];
80 Kuv(i,i) -= soln_factor*phi[i][qp];
81
82 for (unsigned int j = i+1; j < n_dofs; j++)
83 {
84 Kuu(i,j) += rate_factor*phi[j][qp];
85 Kuu(j,i) += rate_factor*phi[j][qp];
86
87 Kuv(i,j) -= soln_factor*phi[j][qp];
88 Kuv(j,i) -= soln_factor*phi[j][qp];
89 }
90 }
91 }
92 }
93 }
94
95 return compute_jacobian;
96}
unsigned int n_vars
bool is_second_order_var(unsigned int var) const
unsigned int get_second_order_dot_var(unsigned int var) const
For a given second order (in time) variable var, this method will return the index to the correspondi...
libmesh_assert(ctx)
FEGenericBase< Real > FEBase
void compute_jacobian(const NumericVector< Number > &, SparseMatrix< Number > &J, NonlinearImplicitSystem &system)
Definition assembly.C:315

References libMesh::TimeSolver::_system, compute_jacobian(), 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::FEAbstract::get_JxW(), libMesh::FEGenericBase< OutputType >::get_phi(), 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::libmesh_assert(), libMesh::make_range(), libMesh::QBase::n_points(), libMesh::DiffContext::n_vars(), libMesh::Variable::type(), and libMesh::System::variable().

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

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

220{ return _diff_solver; }
std::unique_ptr< DiffSolver > _diff_solver
An implicit linear or nonlinear solver to use at each timestep.

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

◆ disable_print_counter_info()

void libMesh::ReferenceCounter::disable_print_counter_info ( )
staticinherited

Definition at line 100 of file reference_counter.C.

101{
102 _enable_print_counter = false;
103 return;
104}
static bool _enable_print_counter
Flag to control whether reference count information is printed when print_info is called.

References libMesh::ReferenceCounter::_enable_print_counter.

◆ 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 348 of file unsteady_solver.C.

349{
350
351 std::unique_ptr<NumericVector<Number>> solution_copy =
352 _system.solution->clone();
353
354 solution_copy->add(-1., _system.get_vector("_old_nonlinear_solution"));
355
356 solution_copy->close();
357
358 return _system.calculate_norm(*solution_copy, norm);
359}
Real calculate_norm(const NumericVector< Number > &v, unsigned int var, FEMNormType norm_type, std::set< unsigned int > *skip_dimensions=nullptr) const
Definition system.C:1511

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

◆ 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 54 of file euler2_solver.C.

56{
58
59 return this->_general_residual(request_jacobian,
60 context,
67}
virtual void elem_reinit(Real)
Gives derived classes the opportunity to reinitialize data (FE objects in FEMSystem,...
virtual bool element_constraint(bool request_jacobian, DiffContext &)
Adds the constraint contribution on elem to elem_residual.
const std::set< unsigned int > & get_second_order_vars() const
virtual bool damping_residual(bool request_jacobian, DiffContext &)
Subtracts a damping vector contribution on elem from elem_residual.
bool _eulerian_time_deriv(bool request_jacobian, DiffContext &)
This method simply combines element_time_derivative() and eulerian_residual(), which makes its addres...
virtual bool mass_residual(bool request_jacobian, DiffContext &)
Subtracts a mass vector contribution on elem from elem_residual.
virtual bool _general_residual(bool request_jacobian, DiffContext &, ResFuncType mass, ResFuncType damping, ResFuncType time_deriv, ResFuncType constraint, ReinitFuncType reinit, bool compute_second_order_eqns)
This method is the underlying implementation of the public residual methods.

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

◆ enable_print_counter_info()

void libMesh::ReferenceCounter::enable_print_counter_info ( )
staticinherited

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

Enabled by default.

Definition at line 94 of file reference_counter.C.

95{
97 return;
98}

References libMesh::ReferenceCounter::_enable_print_counter.

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

◆ error_order()

Real libMesh::Euler2Solver::error_order ( ) const
overridevirtual

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

Implements libMesh::UnsteadySolver.

Definition at line 44 of file euler2_solver.C.

45{
46 if (theta == 0.5)
47 return 2.;
48 return 1.;
49}

References theta.

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

48{
49#if defined(LIBMESH_ENABLE_REFERENCE_COUNTING) && defined(DEBUG)
50
51 std::ostringstream oss;
52
53 oss << '\n'
54 << " ---------------------------------------------------------------------------- \n"
55 << "| Reference count information |\n"
56 << " ---------------------------------------------------------------------------- \n";
57
58 for (const auto & [name, cd] : _counts)
59 oss << "| " << name << " reference count information:\n"
60 << "| Creations: " << cd.first << '\n'
61 << "| Destructions: " << cd.second << '\n';
62
63 oss << " ---------------------------------------------------------------------------- \n";
64
65 return oss.str();
66
67#else
68
69 return "";
70
71#endif
72}
static Counts _counts
Actually holds the data.
std::string name(const ElemQuality q)
This function returns a string containing some name for q.

References libMesh::ReferenceCounter::_counts.

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

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

125{
126 return *solution_history;
127}

References libMesh::TimeSolver::solution_history.

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

◆ increment_constructor_count()

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

Increments the construction counter.

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

Definition at line 183 of file reference_counter.h.

184{
185 libmesh_try
186 {
187 Threads::spin_mutex::scoped_lock lock(Threads::spin_mtx);
188 std::pair<unsigned int, unsigned int> & p = _counts[name];
189 p.first++;
190 }
191 libmesh_catch (...)
192 {
193 auto stream = libMesh::err.get();
194 stream->exceptions(stream->goodbit); // stream must not throw
195 libMesh::err << "Encountered unrecoverable error while calling "
196 << "ReferenceCounter::increment_constructor_count() "
197 << "for a(n) " << name << " object." << std::endl;
198 std::terminate();
199 }
200}
streamT * get()
Rather than implement every ostream/ios/ios_base function, we'll be lazy and make esoteric uses go th...
spin_mutex spin_mtx
A convenient spin mutex object which can be used for obtaining locks.
Definition threads.C:30
OStreamProxy err

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

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

◆ increment_destructor_count()

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

Increments the destruction counter.

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

Definition at line 207 of file reference_counter.h.

208{
209 libmesh_try
210 {
211 Threads::spin_mutex::scoped_lock lock(Threads::spin_mtx);
212 std::pair<unsigned int, unsigned int> & p = _counts[name];
213 p.second++;
214 }
215 libmesh_catch (...)
216 {
217 auto stream = libMesh::err.get();
218 stream->exceptions(stream->goodbit); // stream must not throw
219 libMesh::err << "Encountered unrecoverable error while calling "
220 << "ReferenceCounter::increment_destructor_count() "
221 << "for a(n) " << name << " object." << std::endl;
222 std::terminate();
223 }
224}

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

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

◆ 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 60 of file unsteady_solver.C.

61{
63
64 _system.add_vector("_old_nonlinear_solution");
65}
NumericVector< Number > & add_vector(std::string_view vec_name, const bool projections=true, const ParallelType type=PARALLEL)
Adds the additional vector vec_name to this system.
Definition system.C:756
virtual void init()
The initialization function.
Definition time_solver.C:72

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

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

◆ init_adjoints()

void libMesh::UnsteadySolver::init_adjoints ( )
overridevirtualinherited

Add adjoint vectors and old_adjoint_vectors as per the indices of QoISet.

Reimplemented from libMesh::TimeSolver.

Definition at line 68 of file unsteady_solver.C.

69{
71
72 // Add old adjoint solutions
73 // To keep the number of vectors consistent between the primal and adjoint
74 // time loops, we will also add the adjoint rhs vector during initialization
75 for(auto i : make_range(_system.n_qois()))
76 {
77 std::string old_adjoint_solution_name = "_old_adjoint_solution";
78 old_adjoint_solution_name+= std::to_string(i);
79 _system.add_vector(old_adjoint_solution_name, false, GHOSTED);
80
81 std::string adjoint_rhs_name = "adjoint_rhs";
82 adjoint_rhs_name+= std::to_string(i);
83 _system.add_vector(adjoint_rhs_name, false, GHOSTED);
84 }
85
86}
virtual void init_adjoints()
Initialize any adjoint related data structures, based on the number of qois.
Definition time_solver.C:83

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

◆ 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 89 of file unsteady_solver.C.

90{
92
93#ifdef LIBMESH_ENABLE_GHOSTED
96 GHOSTED);
97#else
99#endif
100}
dof_id_type n_dofs() const
Definition system.C:118
dof_id_type n_local_dofs() const
Definition system.C:155
virtual void init_data()
The data initialization function.
Definition time_solver.C:97

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

◆ integrate_adjoint_refinement_error_estimate()

void libMesh::Euler2Solver::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. The integration scheme used is consistent with the theta used for the unsteady solution. CURRENTLY ONLY SUPPORTED for Backward Euler.

Implements libMesh::FirstOrderUnsteadySolver.

Definition at line 322 of file euler2_solver.C.

323{
324 // Currently, we only support this functionality when Backward-Euler time integration is used.
325 if (theta != 1.0)
326 libmesh_not_implemented();
327
328 // There are two possibilities regarding the integration rule we need to use for time integration.
329 // If we have a instantaneous QoI, then we need to use a left sided Riemann sum, otherwise the trapezoidal rule for temporally smooth QoIs.
330
331 // Create left and right error estimate vectors of the right size
332 std::vector<Number> qoi_error_estimates_left(_system.n_qois());
333 std::vector<Number> qoi_error_estimates_right(_system.n_qois());
334
335 // Get t_j
336 Real time_left = _system.time;
337
338 // Get f(t_j)
339 ErrorVector QoI_elementwise_error_left;
340
341 // If we are at the very initial step, the error contribution is zero,
342 // otherwise the old ajoint vector has been filled and we are the left end
343 // of a subsequent timestep or sub-timestep
344 if(old_adjoints[0] != nullptr)
345 {
346 // For evaluating the residual, we need to use the deltat that was used
347 // to get us to this solution, so we save the current deltat as next_step_deltat
348 // and set _system.deltat to the last completed deltat.
351
352 // The adjoint error estimate expression for a backwards facing step
353 // scheme needs the adjoint for the last time instant, so save the current adjoint for future use
354 for (auto j : make_range(_system.n_qois()))
355 {
356 // Swap for residual weighting
358 }
359
360 _system.update();
361
362 // The residual has to be evaluated at the last time
364
365 adjoint_refinement_error_estimator.estimate_error(_system, QoI_elementwise_error_left);
366
367 // Shift the time back
369
370 // Swap back the current and old adjoints
371 for (auto j : make_range(_system.n_qois()))
372 {
374 }
375
376 // Set the system deltat back to what it should be to march to the next time
378
379 }
380 else
381 {
382 for(auto i : index_range(QoI_elementwise_error))
383 QoI_elementwise_error_left[i] = 0.0;
384 }
385
386 // Also get the left side contributions for the spatially integrated errors for all the QoIs in the QoI set
387 for (auto j : make_range(_system.n_qois()))
388 {
389 // Skip this QoI if not in the QoI Set
390 if (adjoint_refinement_error_estimator.qoi_set().has_index(j))
391 {
392 // If we are at the initial time, the error contribution is zero
393 if(std::abs(_system.time) > TOLERANCE*sqrt(TOLERANCE))
394 {
395 qoi_error_estimates_left[j] = adjoint_refinement_error_estimator.get_global_QoI_error_estimate(j);
396 }
397 else
398 {
399 qoi_error_estimates_left[j] = 0.0;
400 }
401 }
402 }
403
404 // Advance to t_j+1
406
407 // Get t_j+1
408 Real time_right = _system.time;
409
410 // We will need to use the last step deltat for the weighted residual evaluation
412
413 // The adjoint error estimate expression for a backwards facing step
414 // scheme needs the adjoint for the last time instant, so save the current adjoint for future use
415 for (auto j : make_range(_system.n_qois()))
416 {
418 }
419
420 // Retrieve the state and adjoint vectors for the next time instant
422
423 // Swap for residual weighting
424 for (auto j : make_range(_system.n_qois()))
425 {
427 }
428
429 // Swap out the deltats as we did for the left side
432
433 // Get f(t_j+1)
434 ErrorVector QoI_elementwise_error_right;
435
436 _system.update();
437
438 // The residual has to be evaluated at the last time
440
441 adjoint_refinement_error_estimator.estimate_error(_system, QoI_elementwise_error_right);
442
443 // Shift the time back
445
446 // Set the system deltat back to what it needs to be able to march to the next time
448
449 // Swap back now that the residual weighting is done
450 for (auto j : make_range(_system.n_qois()))
451 {
453 }
454
455 // Also get the right side contributions for the spatially integrated errors for all the QoIs in the QoI set
456 for (auto j : make_range(_system.n_qois()))
457 {
458 // Skip this QoI if not in the QoI Set
459 if (adjoint_refinement_error_estimator.qoi_set().has_index(j))
460 {
461 qoi_error_estimates_right[j] = adjoint_refinement_error_estimator.get_global_QoI_error_estimate(j);
462 }
463 }
464
465 // Error contribution from this timestep
466 for (auto i : index_range(QoI_elementwise_error))
467 QoI_elementwise_error[i] = float(((QoI_elementwise_error_right[i] + QoI_elementwise_error_left[i])/2)
468 * (time_right - time_left));
469
470 // QoI set spatially integrated errors contribution from this timestep
471 for (auto j : make_range(_system.n_qois()))
472 {
473 // Skip this QoI if not in the QoI Set
474 if (adjoint_refinement_error_estimator.qoi_set().has_index(j))
475 {
476 _system.set_qoi_error_estimate(j, ( (1.0 - theta)*qoi_error_estimates_left[j] + theta*qoi_error_estimates_right[j] )*last_step_deltat);
477 }
478 }
479
480}
virtual void swap(NumericVector< T > &v)
Swaps the contents of this with v.
virtual std::unique_ptr< NumericVector< T > > clone() const =0
unsigned int n_qois() const
Number of currently active quantities of interest.
Definition system.h:2562
virtual void update()
Update the local values to reflect the solution on neighboring processors.
Definition system.C:498
void set_qoi_error_estimate(unsigned int qoi_index, Number qoi_error_estimate)
Definition system.C:2204
std::vector< std::unique_ptr< NumericVector< Number > > > old_adjoints
A vector of pointers to vectors holding the adjoint solution at the last time step.
virtual void retrieve_timestep() override
This method retrieves all the stored solutions at the current system.time.
Real last_step_deltat
We will need to move the system.time around to ensure that residuals are built with the right deltat ...
auto index_range(const T &sizable)
Helper function that returns an IntRange<std::size_t> representing all the indices of the passed-in v...
Definition int_range.h:153
static constexpr Real TOLERANCE
DIE A HORRIBLE DEATH HERE typedef LIBMESH_DEFAULT_SCALAR_TYPE Real

References libMesh::TimeSolver::_system, libMesh::NumericVector< T >::clone(), libMesh::DifferentiableSystem::deltat, libMesh::AdjointRefinementEstimator::estimate_error(), libMesh::System::get_adjoint_solution(), libMesh::AdjointRefinementEstimator::get_global_QoI_error_estimate(), libMesh::QoISet::has_index(), libMesh::index_range(), libMesh::UnsteadySolver::last_step_deltat, libMesh::make_range(), libMesh::System::n_qois(), libMesh::UnsteadySolver::next_step_deltat, libMesh::UnsteadySolver::old_adjoints, libMesh::AdjointRefinementEstimator::qoi_set(), libMesh::Real, libMesh::UnsteadySolver::retrieve_timestep(), libMesh::System::set_qoi_error_estimate(), libMesh::NumericVector< T >::swap(), theta, libMesh::System::time, libMesh::TOLERANCE, and libMesh::System::update().

◆ integrate_adjoint_sensitivity()

void libMesh::UnsteadySolver::integrate_adjoint_sensitivity ( const QoISet qois,
const ParameterVector parameter_vector,
SensitivityData sensitivities 
)
overridevirtualinherited

A method to integrate the adjoint sensitivity w.r.t a given parameter vector.

int_{tstep_start}^{tstep_end} dQ/dp dt = int_{tstep_start}^{tstep_end} (\partialQ / \partial p) - ( \partial R (u,z) / \partial p ) dt The trapezoidal rule is used to numerically integrate the timestep.

Reimplemented from libMesh::TimeSolver.

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

Definition at line 280 of file unsteady_solver.C.

281{
282 // CURRENTLY using the trapezoidal rule to integrate each timestep
283 // (f(t_j) + f(t_j+1))/2 (t_j+1 - t_j)
284 // Fix me: This function needs to be moved to the EulerSolver classes like the
285 // other integrate_timestep functions, and use an integration rule consistent with
286 // the theta method used for the time integration.
287
288 // Get t_j
289 Real time_left = _system.time;
290
291 // Left side sensitivities to hold f(t_j)
292 SensitivityData sensitivities_left(qois, _system, parameter_vector);
293
294 // Get f(t_j)
295 _system.adjoint_qoi_parameter_sensitivity(qois, parameter_vector, sensitivities_left);
296
297 // Advance to t_j+1
299
300 // Get t_j+1
301 Real time_right = _system.time;
302
303 // Right side sensitivities f(t_j+1)
304 SensitivityData sensitivities_right(qois, _system, parameter_vector);
305
306 // Remove the sensitivity rhs vector from system since we did not write it to file and it cannot be retrieved
307 _system.remove_vector("sensitivity_rhs0");
308
309 // Retrieve the primal and adjoint solutions at the current timestep
311
312 // Get f(t_j+1)
313 _system.adjoint_qoi_parameter_sensitivity(qois, parameter_vector, sensitivities_right);
314
315 // Remove the sensitivity rhs vector from system since we did not write it to file and it cannot be retrieved
316 _system.remove_vector("sensitivity_rhs0");
317
318 // Get the contributions for each sensitivity from this timestep
319 const auto pv_size = parameter_vector.size();
320 for (auto i : make_range(qois.size(_system)))
321 for (auto j : make_range(pv_size))
322 sensitivities[i][j] = ( (sensitivities_left[i][j] + sensitivities_right[i][j])/2. )*(time_right - time_left);
323}
virtual void adjoint_qoi_parameter_sensitivity(const QoISet &qoi_indices, const ParameterVector &parameters, SensitivityData &sensitivities) override
Solves for the derivative of each of the system's quantities of interest q in qoi[qoi_indices] with r...
void remove_vector(std::string_view vec_name)
Removes the additional vector vec_name from this system.
Definition system.C:861

References libMesh::TimeSolver::_system, libMesh::ImplicitSystem::adjoint_qoi_parameter_sensitivity(), libMesh::DifferentiableSystem::deltat, libMesh::make_range(), libMesh::Real, libMesh::System::remove_vector(), libMesh::UnsteadySolver::retrieve_timestep(), libMesh::ParameterVector::size(), libMesh::QoISet::size(), and libMesh::System::time.

◆ integrate_qoi_timestep()

void libMesh::Euler2Solver::integrate_qoi_timestep ( )
overridevirtual

A method to integrate the system::QoI functionals.

Implements libMesh::FirstOrderUnsteadySolver.

Definition at line 264 of file euler2_solver.C.

265{
266 // We use a numerical integration scheme consistent with the theta used for the timesolver.
267
268 // Zero out the system.qoi vector
269 for (auto j : make_range(_system.n_qois()))
270 {
271 _system.set_qoi(j, 0.0);
272 }
273
274 // Left and right side contributions
275 std::vector<Number> left_contribution(_system.n_qois(), 0.0);
276 Number time_left = 0.0;
277 std::vector<Number> right_contribution(_system.n_qois(), 0.0);
278 Number time_right = 0.0;
279
280 time_left = _system.time;
281
282 // Base class assumes a direct steady evaluation
283 this->_system.assemble_qoi();
284
285 // Also get the spatially integrated errors for all the QoIs in the QoI set
286 for (auto j : make_range(_system.n_qois()))
287 {
288 left_contribution[j] = _system.get_qoi_value(j);
289 }
290
291 // Advance to t_j+1
293
294 time_right = _system.time;
295
296 // Load the solution at the next timestep
298
299 // Zero out the system.qoi vector
300 for (auto j : make_range(_system.n_qois()))
301 {
302 _system.set_qoi(j, 0.0);
303 }
304
305 // Base class assumes a direct steady evaluation
306 this->_system.assemble_qoi();
307
308 for(auto j : make_range(_system.n_qois()))
309 {
310 right_contribution[j] = _system.get_qoi_value(j);
311 }
312
313 // Combine the left and right side contributions as per the specified theta
314 // theta = 0.5 (Crank-Nicholson) gives the trapezoidal rule.
315 for (auto j : make_range(_system.n_qois()))
316 {
317 _system.set_qoi(j, ( ( ((1.0 - theta)*left_contribution[j]) + (theta*right_contribution[j]) )/2.0 )*(time_right - time_left));
318 }
319}
virtual void assemble_qoi(const QoISet &qoi_indices=QoISet()) override
Prepares qoi for quantity of interest assembly, then calls user qoi function.
void set_qoi(unsigned int qoi_index, Number qoi_value)
Definition system.C:2176
Number get_qoi_value(unsigned int qoi_index) const
Definition system.C:2184

References libMesh::TimeSolver::_system, libMesh::ExplicitSystem::assemble_qoi(), libMesh::DifferentiableSystem::deltat, libMesh::System::get_qoi_value(), libMesh::make_range(), libMesh::System::n_qois(), libMesh::UnsteadySolver::retrieve_timestep(), libMesh::System::set_qoi(), theta, and libMesh::System::time.

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

278 { return _is_adjoint; }
bool _is_adjoint
This boolean tells the TimeSolver whether we are solving a primal or adjoint problem.

References libMesh::TimeSolver::_is_adjoint.

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

◆ is_steady()

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

This is not a steady-state solver.

Implements libMesh::TimeSolver.

Definition at line 194 of file unsteady_solver.h.

194{ return false; }

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

161{
162 return last_deltat;
163}

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

225{ return _linear_solver; }
std::unique_ptr< LinearSolver< Number > > _linear_solver
An implicit linear solver to use for adjoint problems.

References libMesh::TimeSolver::_linear_solver.

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

◆ n_objects()

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

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

Definition at line 85 of file reference_counter.h.

86 { return _n_objects; }
static Threads::atomic< unsigned int > _n_objects
The number of objects.

References libMesh::ReferenceCounter::_n_objects.

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

◆ 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 86 of file euler2_solver.C.

88{
90
91 return this->_general_residual(request_jacobian,
92 context,
99}
virtual void nonlocal_reinit(Real)
Gives derived classes the opportunity to reinitialize data needed for nonlocal calculations at a new ...
virtual bool nonlocal_constraint(bool request_jacobian, DiffContext &)
Adds any nonlocal constraint contributions (e.g.
virtual bool nonlocal_time_derivative(bool request_jacobian, DiffContext &)
Adds any nonlocal time derivative contributions (e.g.
virtual bool nonlocal_damping_residual(bool request_jacobian, DiffContext &)
Subtracts any nonlocal damping vector contributions (e.g.
virtual bool nonlocal_mass_residual(bool request_jacobian, DiffContext &c)
Subtracts any nonlocal mass vector contributions (e.g.
bool have_second_order_scalar_vars() const
Check for any second order vars that are also belong to FEFamily::SCALAR.

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

◆ 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 337 of file unsteady_solver.C.

339{
340 libmesh_assert_less (global_dof_number, _system.get_dof_map().n_dofs());
341 libmesh_assert_less (global_dof_number, old_local_nonlinear_solution->size());
342
343 return (*old_local_nonlinear_solution)(global_dof_number);
344}
dof_id_type n_dofs(const unsigned int vn) const
Definition dof_map.h:776

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

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

◆ 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 26 of file first_order_unsteady_solver.C.

27{
28 context.get_elem_solution_accel() = context.get_elem_solution_rate();
29
30 context.elem_solution_accel_derivative = context.get_elem_solution_rate_derivative();
31}

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 _general_residual(), and libMesh::EulerSolver::_general_residual().

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

82{
84 out_stream << ReferenceCounter::get_info();
85}
static std::string get_info()
Gets a string containing the reference information.

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

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

◆ 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::AdaptiveTimeSolver, and libMesh::SecondOrderUnsteadySolver.

Definition at line 104 of file unsteady_solver.C.

105{
107
108#ifdef LIBMESH_ENABLE_GHOSTED
111 GHOSTED);
112#else
114#endif
115
116 // localize the old solution
117 NumericVector<Number> & old_nonlinear_soln =
118 _system.get_vector("_old_nonlinear_solution");
119
120 old_nonlinear_soln.localize
123}
virtual void reinit()
The reinitialization function.
Definition time_solver.C:54

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

◆ retrieve_timestep()

void libMesh::UnsteadySolver::retrieve_timestep ( )
overridevirtualinherited

◆ set_first_adjoint_step()

void libMesh::UnsteadySolver::set_first_adjoint_step ( bool  first_adjoint_step_setting)
inlineinherited

A setter for the first_adjoint_step boolean.

Needed for nested time solvers.

Definition at line 199 of file unsteady_solver.h.

200 {
201 first_adjoint_step = first_adjoint_step_setting;
202 }
bool first_adjoint_step
A bool that will be true the first time adjoint_advance_timestep() is called, (when the primal soluti...

References libMesh::UnsteadySolver::first_adjoint_step.

◆ set_first_solve()

void libMesh::UnsteadySolver::set_first_solve ( bool  first_solve_setting)
inlineinherited

Definition at line 209 of file unsteady_solver.h.

210 {
211 first_solve = first_solve_setting;
212 }

References libMesh::UnsteadySolver::first_solve.

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

285 { _is_adjoint = _is_adjoint_value; }

References libMesh::TimeSolver::_is_adjoint.

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

◆ set_solution_history()

void libMesh::TimeSolver::set_solution_history ( const SolutionHistory _solution_history)
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.

120{
121 solution_history = _solution_history.clone();
122}

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

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

◆ 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 71 of file euler2_solver.C.

73{
74 return this->_general_residual(request_jacobian,
75 context,
81 false);
82}
virtual void elem_side_reinit(Real)
Gives derived classes the opportunity to reinitialize data needed for a side integration at a new poi...
virtual bool side_mass_residual(bool request_jacobian, DiffContext &)
Subtracts a mass vector contribution on side of elem from elem_residual.
virtual bool side_time_derivative(bool request_jacobian, DiffContext &)
Adds the time derivative contribution on side of elem to elem_residual.
virtual bool side_constraint(bool request_jacobian, DiffContext &)
Adds the constraint contribution on side of elem to elem_residual.
virtual bool side_damping_residual(bool request_jacobian, DiffContext &)
Subtracts a damping vector contribution on side of elem from elem_residual.

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

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

Definition at line 127 of file unsteady_solver.C.

128{
129 if (first_solve)
130 {
132 first_solve = false;
133 }
134
135 unsigned int solve_result = _diff_solver->solve();
136
137 // If we requested the UnsteadySolver to attempt reducing dt after a
138 // failed DiffSolver solve, check the results of the solve now.
140 {
141 bool backtracking_failed =
143
144 bool max_iterations =
146
147 if (backtracking_failed || max_iterations)
148 {
149 // Cut timestep in half
150 for (unsigned int nr=0; nr<reduce_deltat_on_diffsolver_failure; ++nr)
151 {
152 _system.deltat *= 0.5;
153 libMesh::out << "Newton backtracking failed. Trying with smaller timestep, dt="
154 << _system.deltat << std::endl;
155
156 solve_result = _diff_solver->solve();
157
158 // Check solve results with reduced timestep
159 bool backtracking_still_failed =
161
162 bool backtracking_max_iterations =
164
165 if (!backtracking_still_failed && !backtracking_max_iterations)
166 {
167 // Set the successful deltat as the last deltat
169
170 if (!quiet)
171 libMesh::out << "Reduced dt solve succeeded." << std::endl;
172 return;
173 }
174 }
175
176 // If we made it here, we still couldn't converge the solve after
177 // reducing deltat
178 libMesh::out << "DiffSolver::solve() did not succeed after "
180 << " attempts." << std::endl;
181 libmesh_convergence_failure();
182
183 } // end if (backtracking_failed || max_iterations)
184 } // end if (reduce_deltat_on_diffsolver_failure)
185
186 // Set the successful deltat as the last deltat
188}
@ DIVERGED_BACKTRACKING_FAILURE
The DiffSolver failed to find a descent direction by backtracking (See newton_solver....
@ DIVERGED_MAX_NONLINEAR_ITERATIONS
The DiffSolver reached the maximum allowed number of nonlinear iterations before satisfying any conve...
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 ...
bool quiet
Print extra debugging information if quiet == false.
virtual void advance_timestep() override
This method advances the solution to the next timestep, after a solve() has been performed.
OStreamProxy out

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::TimeSolver::last_deltat, libMesh::out, libMesh::TimeSolver::quiet, and libMesh::TimeSolver::reduce_deltat_on_diffsolver_failure.

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

◆ system() [1/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.

215{ return _system; }

References libMesh::TimeSolver::_system.

◆ system() [2/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.

210{ return _system; }

References libMesh::TimeSolver::_system.

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

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

◆ update()

void libMesh::UnsteadySolver::update ( )
inherited

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

◆ _is_adjoint

bool libMesh::TimeSolver::_is_adjoint
privateinherited

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

Definition at line 340 of file time_solver.h.

Referenced by libMesh::TimeSolver::is_adjoint(), and libMesh::TimeSolver::set_is_adjoint().

◆ _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

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

◆ 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 226 of file unsteady_solver.h.

Referenced by libMesh::AdaptiveTimeSolver::adjoint_advance_timestep(), and libMesh::UnsteadySolver::set_first_adjoint_step().

◆ first_solve

bool libMesh::UnsteadySolver::first_solve
protectedinherited

◆ last_deltat

Real libMesh::TimeSolver::last_deltat
protectedinherited

◆ last_step_deltat

Real libMesh::UnsteadySolver::last_step_deltat
protectedinherited

We will need to move the system.time around to ensure that residuals are built with the right deltat and the right time.

Definition at line 237 of file unsteady_solver.h.

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

◆ next_step_deltat

Real libMesh::UnsteadySolver::next_step_deltat
protectedinherited

◆ old_adjoints

std::vector< std::unique_ptr<NumericVector<Number> > > libMesh::UnsteadySolver::old_adjoints
protectedinherited

A vector of pointers to vectors holding the adjoint solution at the last time step.

Definition at line 231 of file unsteady_solver.h.

Referenced by integrate_adjoint_refinement_error_estimate(), libMesh::EulerSolver::integrate_adjoint_refinement_error_estimate(), and libMesh::UnsteadySolver::UnsteadySolver().

◆ old_local_nonlinear_solution

std::shared_ptr<NumericVector<Number> > libMesh::UnsteadySolver::old_local_nonlinear_solution
inherited

◆ 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::EigenTimeSolver::solve(), libMesh::TwostepTimeSolver::solve(), and libMesh::UnsteadySolver::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

◆ 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 122 of file euler2_solver.h.

Referenced by _general_residual(), error_order(), integrate_adjoint_refinement_error_estimate(), integrate_qoi_timestep(), and main().


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