libMesh
diff_context.C
Go to the documentation of this file.
1 // The libMesh Finite Element Library.
2 // Copyright (C) 2002-2019 Benjamin S. Kirk, John W. Peterson, Roy H. Stogner
3 
4 // This library is free software; you can redistribute it and/or
5 // modify it under the terms of the GNU Lesser General Public
6 // License as published by the Free Software Foundation; either
7 // version 2.1 of the License, or (at your option) any later version.
8 
9 // This library is distributed in the hope that it will be useful,
10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 // Lesser General Public License for more details.
13 
14 // You should have received a copy of the GNU Lesser General Public
15 // License along with this library; if not, write to the Free Software
16 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17 
18 
19 #include "libmesh/diff_context.h"
20 #include "libmesh/diff_system.h"
21 #include "libmesh/diff_system.h"
22 #include "libmesh/unsteady_solver.h"
23 #include "libmesh/auto_ptr.h" // libmesh_make_unique
24 
25 namespace libMesh
26 {
27 
28 
29 
31  time(sys.time),
32  system_time(sys.time),
33  elem_solution_derivative(1.),
34  elem_solution_rate_derivative(1.),
35  elem_solution_accel_derivative(1.),
36  fixed_solution_derivative(0.),
37  _dof_indices_var(sys.n_vars()),
38  _deltat(nullptr),
39  _system(sys),
40  _is_adjoint(false)
41 {
42  // Finally initialize solution/residual/jacobian data structures
43  unsigned int nv = sys.n_vars();
44 
45  _elem_subsolutions.reserve(nv);
46  _elem_subresiduals.reserve(nv);
47  _elem_subjacobians.resize(nv);
48  _elem_subsolution_rates.reserve(nv);
49  _elem_subsolution_accels.reserve(nv);
50  if (sys.use_fixed_solution)
51  _elem_fixed_subsolutions.reserve(nv);
52 
53  // If the user resizes sys.qoi, it will invalidate us
54 
55  std::size_t n_qoi = sys.qoi.size();
56  _elem_qoi.resize(n_qoi);
57  _elem_qoi_derivative.resize(n_qoi);
58  _elem_qoi_subderivatives.resize(n_qoi);
59  for (std::size_t q=0; q != n_qoi; ++q)
60  _elem_qoi_subderivatives[q].reserve(nv);
61 
62  for (unsigned int i=0; i != nv; ++i)
63  {
64  _elem_subsolutions.emplace_back(libmesh_make_unique<DenseSubVector<Number>>(_elem_solution));
65  _elem_subresiduals.emplace_back(libmesh_make_unique<DenseSubVector<Number>>(_elem_residual));
66  for (std::size_t q=0; q != n_qoi; ++q)
67  _elem_qoi_subderivatives[q].emplace_back(libmesh_make_unique<DenseSubVector<Number>>(_elem_qoi_derivative[q]));
68  _elem_subjacobians[i].reserve(nv);
69 
70  // Only make space for these if we're using DiffSystem
71  // This is assuming *only* DiffSystem is using elem_solution_rate/accel
72  const DifferentiableSystem * diff_system = dynamic_cast<const DifferentiableSystem *>(&sys);
73  if (diff_system)
74  {
75  // Now, we only need these if the solver is unsteady
76  if (!diff_system->get_time_solver().is_steady())
77  {
78  _elem_subsolution_rates.emplace_back(libmesh_make_unique<DenseSubVector<Number>>(_elem_solution_rate));
79 
80  // We only need accel space if the TimeSolver is second order
81  const UnsteadySolver & time_solver = cast_ref<const UnsteadySolver &>(diff_system->get_time_solver());
82 
83  if (time_solver.time_order() >= 2 || !diff_system->get_second_order_vars().empty())
84  _elem_subsolution_accels.emplace_back(libmesh_make_unique<DenseSubVector<Number>>(_elem_solution_accel));
85  }
86  }
87 
88  if (sys.use_fixed_solution)
89  _elem_fixed_subsolutions.emplace_back(libmesh_make_unique<DenseSubVector<Number>>(_elem_fixed_solution));
90 
91  for (unsigned int j=0; j != nv; ++j)
92  _elem_subjacobians[i].emplace_back(libmesh_make_unique<DenseSubMatrix<Number>>(_elem_jacobian));
93  }
94 }
95 
96 
97 
99 {
100 }
101 
102 
104 {
105  // We may actually want to be able to set this pointer to nullptr, so
106  // don't report an error for that.
107  _deltat = dt;
108 }
109 
110 
112 {
114 
115  return *_deltat;
116 }
117 
118 
119 void DiffContext::add_localized_vector (NumericVector<Number> & localized_vector, const System & sys)
120 {
121  // Make an empty pair keyed with a reference to this _localized_vector
122  _localized_vectors[&localized_vector] = std::make_pair(DenseVector<Number>(), std::vector<std::unique_ptr<DenseSubVector<Number>>>());
123 
124  unsigned int nv = sys.n_vars();
125 
126  _localized_vectors[&localized_vector].second.reserve(nv);
127 
128  // Fill the DenseSubVector with nv copies of DenseVector
129  for (unsigned int i=0; i != nv; ++i)
130  _localized_vectors[&localized_vector].second.emplace_back(libmesh_make_unique<DenseSubVector<Number>>(_localized_vectors[&localized_vector].first));
131 }
132 
133 
135 {
136  return _localized_vectors[&localized_vector].first;
137 }
138 
139 
141 {
142  auto localized_vectors_it = _localized_vectors.find(&localized_vector);
143  libmesh_assert(localized_vectors_it != _localized_vectors.end());
144  return localized_vectors_it->second.first;
145 }
146 
147 
149 {
150  return *_localized_vectors[&localized_vector].second[var];
151 }
152 
153 
154 const DenseSubVector<Number> & DiffContext::get_localized_subvector (const NumericVector<Number> & localized_vector, unsigned int var) const
155 {
156  auto localized_vectors_it = _localized_vectors.find(&localized_vector);
157  libmesh_assert(localized_vectors_it != _localized_vectors.end());
158  return *localized_vectors_it->second.second[var];
159 }
160 
161 } // namespace libMesh
libMesh::System
Manages consistently variables, degrees of freedom, and coefficient vectors.
Definition: system.h:100
libMesh::DiffContext::_elem_qoi_subderivatives
std::vector< std::vector< std::unique_ptr< DenseSubVector< Number > > > > _elem_qoi_subderivatives
Definition: diff_context.h:626
libMesh::System::n_vars
unsigned int n_vars() const
Definition: system.h:2155
libMesh::DiffContext::get_localized_subvector
DenseSubVector< Number > & get_localized_subvector(const NumericVector< Number > &localized_vector, unsigned int var)
Return a reference to DenseSubVector localization of localized_vector at variable var contained in th...
Definition: diff_context.C:148
libMesh::DiffContext::DiffContext
DiffContext(const System &)
Constructor.
Definition: diff_context.C:30
libMesh::DiffContext::_deltat
Real * _deltat
Defaults to nullptr, can optionally be used to point to a timestep value in the System-derived class ...
Definition: diff_context.h:653
libMesh::DiffContext::_elem_solution_accel
DenseVector< Number > _elem_solution_accel
Element by element components of du/dt as adjusted by a time_solver.
Definition: diff_context.h:595
n_vars
unsigned int n_vars
Definition: adaptivity_ex3.C:116
libMesh::DenseSubMatrix
Defines a dense submatrix for use in Finite Element-type computations.
Definition: dense_submatrix.h:45
libMesh
The libMesh namespace provides an interface to certain functionality in the library.
Definition: factoryfunction.C:55
libMesh::DiffContext::_elem_residual
DenseVector< Number > _elem_residual
Element residual vector.
Definition: diff_context.h:609
libMesh::DiffContext::get_localized_vector
DenseVector< Number > & get_localized_vector(const NumericVector< Number > &localized_vector)
Return a reference to DenseVector localization of localized_vector contained in the _localized_vector...
Definition: diff_context.C:134
libMesh::DifferentiableSystem
This class provides a specific system class.
Definition: diff_system.h:53
libMesh::DiffContext::_elem_subsolutions
std::vector< std::unique_ptr< DenseSubVector< Number > > > _elem_subsolutions
Definition: diff_context.h:582
libMesh::System::use_fixed_solution
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:1509
libMesh::DiffContext::_localized_vectors
std::map< const NumericVector< Number > *, std::pair< DenseVector< Number >, std::vector< std::unique_ptr< DenseSubVector< Number > > > > > _localized_vectors
Contains pointers to vectors the user has asked to be localized, keyed with pairs of element localize...
Definition: diff_context.h:575
libMesh::DiffContext::_elem_solution
DenseVector< Number > _elem_solution
Element by element components of nonlinear_solution as adjusted by a time_solver.
Definition: diff_context.h:581
libMesh::DiffContext::_elem_subsolution_rates
std::vector< std::unique_ptr< DenseSubVector< Number > > > _elem_subsolution_rates
Definition: diff_context.h:589
libMesh::NumericVector< Number >
libMesh::libmesh_assert
libmesh_assert(ctx)
libMesh::DifferentiablePhysics::get_second_order_vars
const std::set< unsigned int > & get_second_order_vars() const
Definition: diff_physics.h:531
libMesh::System::qoi
std::vector< Number > qoi
Values of the quantities of interest.
Definition: system.h:1574
libMesh::UnsteadySolver
This is a generic class that defines a solver to handle time integration of DifferentiableSystems.
Definition: unsteady_solver.h:48
libMesh::DiffContext::set_deltat_pointer
void set_deltat_pointer(Real *dt)
Points the _deltat member of this class at a timestep value stored in the creating System,...
Definition: diff_context.C:103
libMesh::DiffContext::_elem_fixed_subsolutions
std::vector< std::unique_ptr< DenseSubVector< Number > > > _elem_fixed_subsolutions
Definition: diff_context.h:604
libMesh::DifferentiableSystem::get_time_solver
TimeSolver & get_time_solver()
Definition: diff_system.h:416
libMesh::DenseSubVector< Number >
libMesh::DiffContext::_elem_fixed_solution
DenseVector< Number > _elem_fixed_solution
Element by element components of nonlinear_solution at a fixed point in a timestep,...
Definition: diff_context.h:603
libMesh::DiffContext::_elem_qoi_derivative
std::vector< DenseVector< Number > > _elem_qoi_derivative
Element quantity of interest derivative contributions.
Definition: diff_context.h:625
libMesh::DiffContext::_elem_qoi
std::vector< Number > _elem_qoi
Element quantity of interest contributions.
Definition: diff_context.h:620
libMesh::DiffContext::_elem_solution_rate
DenseVector< Number > _elem_solution_rate
Element by element components of du/dt as adjusted by a time_solver.
Definition: diff_context.h:588
libMesh::DiffContext::_elem_subresiduals
std::vector< std::unique_ptr< DenseSubVector< Number > > > _elem_subresiduals
Element residual subvectors and Jacobian submatrices.
Definition: diff_context.h:631
libMesh::UnsteadySolver::time_order
virtual unsigned int time_order() const =0
libMesh::Real
DIE A HORRIBLE DEATH HERE typedef LIBMESH_DEFAULT_SCALAR_TYPE Real
Definition: libmesh_common.h:121
libMesh::DiffContext::_elem_subjacobians
std::vector< std::vector< std::unique_ptr< DenseSubMatrix< Number > > > > _elem_subjacobians
Definition: diff_context.h:632
libMesh::DiffContext::get_deltat_value
Real get_deltat_value()
Definition: diff_context.C:111
libMesh::DiffContext::~DiffContext
virtual ~DiffContext()
Destructor.
Definition: diff_context.C:98
libMesh::DiffContext::_elem_jacobian
DenseMatrix< Number > _elem_jacobian
Element jacobian: derivatives of elem_residual with respect to elem_solution.
Definition: diff_context.h:615
libMesh::DiffContext::add_localized_vector
void add_localized_vector(NumericVector< Number > &localized_vector, const System &sys)
Adds a vector to the map of localized vectors.
Definition: diff_context.C:119
libMesh::DiffContext::_elem_subsolution_accels
std::vector< std::unique_ptr< DenseSubVector< Number > > > _elem_subsolution_accels
Definition: diff_context.h:596
libMesh::TimeSolver::is_steady
virtual bool is_steady() const =0
Is this effectively a steady-state solver?
libMesh::DenseVector< Number >