OGS
NumLib::TimeDiscretizedODESystem< ODESystemTag::FirstOrderImplicitQuasilinear, NonlinearSolverTag::Newton > Class Referencefinal

Detailed Description

Time discretized first order implicit quasi-linear ODE; to be solved using the Newton-Raphson method for resolving nonlinearities.

See also
ODESystemTag::FirstOrderImplicitQuasilinear

Definition at line 57 of file TimeDiscretizedODESystem.h.

#include <TimeDiscretizedODESystem.h>

Inheritance diagram for NumLib::TimeDiscretizedODESystem< ODESystemTag::FirstOrderImplicitQuasilinear, NonlinearSolverTag::Newton >:
[legend]
Collaboration diagram for NumLib::TimeDiscretizedODESystem< ODESystemTag::FirstOrderImplicitQuasilinear, NonlinearSolverTag::Newton >:
[legend]

Public Types

using ODE = ODESystem< ODETag, NonlinearSolverTag::Newton >
 The type of ODE. More...
 
using MatTrans = MatrixTranslator< ODETag >
 
using TimeDisc = TimeDiscretization
 A shortcut for a general time discretization scheme. More...
 

Public Member Functions

 TimeDiscretizedODESystem (const int process_id, ODE &ode, TimeDisc &time_discretization)
 
 ~TimeDiscretizedODESystem () override
 
void assemble (std::vector< GlobalVector * > const &x_new_timestep, std::vector< GlobalVector * > const &x_prev, int const process_id) override
 
std::vector< GlobalIndexTypegetIndicesOfResiduumWithoutInitialCompensation () const override
 
void getResidual (GlobalVector const &x_new_timestep, GlobalVector const &x_prev, GlobalVector &res) const override
 
void getJacobian (GlobalMatrix &Jac) const override
 
void computeKnownSolutions (GlobalVector const &x, int const process_id) override
 
void applyKnownSolutions (GlobalVector &x) const override
 
void applyKnownSolutionsNewton (GlobalMatrix &Jac, GlobalVector &res, GlobalVector &minus_delta_x) const override
 
void updateConstraints (GlobalVector &lower, GlobalVector &upper, int const process_id) override
 
bool isLinear () const override
 
void preIteration (const unsigned iter, GlobalVector const &x) override
 
IterationResult postIteration (GlobalVector const &x) override
 
TimeDiscgetTimeDiscretization () override
 Exposes the used time discretization scheme. More...
 
MathLib::MatrixSpecifications getMatrixSpecifications (const int process_id) const override
 
virtual TimeDiscretizationgetTimeDiscretization ()=0
 Exposes the used time discretization scheme. More...
 

Static Public Attributes

static const ODESystemTag ODETag
 A tag indicating the type of ODE. More...
 

Private Types

using Index = MathLib::MatrixVectorTraits< GlobalMatrix >::Index
 

Private Attributes

ODE_ode
 ode the ODE being wrapped More...
 
TimeDisc_time_disc
 the time discretization to being used More...
 
std::unique_ptr< MatTrans_mat_trans
 the object used to compute the matrix/vector for the nonlinear solver More...
 
std::vector< NumLib::IndexValueVector< Index > > const * _known_solutions
 stores precomputed values for known solutions More...
 
GlobalMatrix_Jac
 the Jacobian of the residual More...
 
GlobalMatrix_M
 Matrix \( M \). More...
 
GlobalMatrix_K
 Matrix \( K \). More...
 
GlobalVector_b
 Matrix \( b \). More...
 
std::size_t _Jac_id = 0u
 ID of the _Jac matrix. More...
 
std::size_t _M_id = 0u
 ID of the _M matrix. More...
 
std::size_t _K_id = 0u
 ID of the _K matrix. More...
 
std::size_t _b_id = 0u
 ID of the _b vector. More...
 
std::size_t _xdot_id = 0u
 ID of the vector storing xdot in intermediate computations. More...
 
std::vector< std::size_t > _xdot_ids
 

Member Typedef Documentation

◆ Index

◆ MatTrans

The auxiliary class that computes the matrix/vector used by the nonlinear solver.

Definition at line 70 of file TimeDiscretizedODESystem.h.

◆ ODE

◆ TimeDisc

A shortcut for a general time discretization scheme.

Definition at line 72 of file TimeDiscretizedODESystem.h.

Constructor & Destructor Documentation

◆ TimeDiscretizedODESystem()

NumLib::TimeDiscretizedODESystem< ODESystemTag::FirstOrderImplicitQuasilinear, NonlinearSolverTag::Newton >::TimeDiscretizedODESystem ( const int  process_id,
ODE ode,
TimeDisc time_discretization 
)
explicit

Constructs a new instance.

Parameters
process_idID of the ODE to be solved.
odethe ODE to be wrapped.
time_discretizationthe time discretization to be used.

Definition at line 46 of file TimeDiscretizedODESystem.cpp.

49 : _ode(ode),
50 _time_disc(time_discretization),
51 _mat_trans(createMatrixTranslator<ODETag>(time_discretization))
52{
54 _ode.getMatrixSpecifications(process_id), _Jac_id);
56 _ode.getMatrixSpecifications(process_id), _M_id);
58 _ode.getMatrixSpecifications(process_id), _K_id);
60 _ode.getMatrixSpecifications(process_id), _b_id);
61}
virtual GlobalMatrix & getMatrix(std::size_t &id)=0
Get an uninitialized matrix with the given id.
std::unique_ptr< MatTrans > _mat_trans
the object used to compute the matrix/vector for the nonlinear solver
virtual GlobalVector & getVector(std::size_t &id)=0
Get an uninitialized vector with the given id.
static NUMLIB_EXPORT MatrixProvider & provider
static NUMLIB_EXPORT VectorProvider & provider

References NumLib::MatrixProvider::getMatrix(), NumLib::VectorProvider::getVector(), NumLib::GlobalVectorProvider::provider, and NumLib::GlobalMatrixProvider::provider.

◆ ~TimeDiscretizedODESystem()

Member Function Documentation

◆ applyKnownSolutions()

Definition at line 160 of file TimeDiscretizedODESystem.cpp.

161{
163}
std::vector< NumLib::IndexValueVector< Index > > const * _known_solutions
stores precomputed values for known solutions
void applyKnownSolutions(std::vector< Solutions > const *const known_solutions, Vector &x)
Applies known solutions to the solution vector x.

References detail::applyKnownSolutions().

◆ applyKnownSolutionsNewton()

void NumLib::TimeDiscretizedODESystem< ODESystemTag::FirstOrderImplicitQuasilinear, NonlinearSolverTag::Newton >::applyKnownSolutionsNewton ( GlobalMatrix Jac,
GlobalVector res,
GlobalVector minus_delta_x 
) const
override

Definition at line 166 of file TimeDiscretizedODESystem.cpp.

169{
170 if (!_known_solutions)
171 {
172 return;
173 }
174
176 std::vector<IndexType> ids;
177 for (auto const& bc : *_known_solutions)
178 {
179 ids.insert(end(ids), begin(bc.ids), end(bc.ids));
180 }
181
182 // For the Newton method the values must be zero
183 std::vector<double> values(ids.size(), 0);
184 MathLib::applyKnownSolution(Jac, res, minus_delta_x, ids, values);
185}
void applyKnownSolution(EigenMatrix &A, EigenVector &b, EigenVector &, const std::vector< EigenMatrix::IndexType > &vec_knownX_id, const std::vector< double > &vec_knownX_x)
Definition: EigenTools.cpp:17
constexpr ranges::views::view_closure ids
For an element of a range view return its id.
Definition: Mesh.h:313

References MathLib::applyKnownSolution(), and MeshLib::views::ids.

◆ assemble()

void NumLib::TimeDiscretizedODESystem< ODESystemTag::FirstOrderImplicitQuasilinear, NonlinearSolverTag::Newton >::assemble ( std::vector< GlobalVector * > const &  x_new_timestep,
std::vector< GlobalVector * > const &  x_prev,
int const  process_id 
)
override

Definition at line 74 of file TimeDiscretizedODESystem.cpp.

78{
79 namespace LinAlg = MathLib::LinAlg;
80
81 auto const t = _time_disc.getCurrentTime();
82 auto const dt = _time_disc.getCurrentTimeIncrement();
83 auto const& x_curr = *x_new_timestep[process_id];
84
85 std::vector<GlobalVector*> xdot(x_new_timestep.size());
86 _xdot_ids.resize(x_new_timestep.size());
87 for (std::size_t i = 0; i < xdot.size(); i++)
88 {
89 xdot[i] =
91 _time_disc.getXdot(*x_new_timestep[i], *x_prev[i], *xdot[i]);
92 }
93
94 _M->setZero();
95 _K->setZero();
96 _b->setZero();
97 _Jac->setZero();
98
99 _ode.preAssemble(t, dt, x_curr);
100 try
101 {
102 _ode.assembleWithJacobian(t, dt, x_new_timestep, xdot, process_id, *_M,
103 *_K, *_b, *_Jac);
104 }
105 catch (AssemblyException const&)
106 {
107 for (auto& v : xdot)
108 {
110 }
111 throw;
112 }
113
118
119 for (auto& v : xdot)
120 {
122 }
123}
void setZero()
reset data entries to zero.
Definition: EigenMatrix.h:65
void getXdot(GlobalVector const &x_at_new_timestep, GlobalVector const &x_old, GlobalVector &xdot) const
virtual double getCurrentTimeIncrement() const =0
virtual double getCurrentTime() const =0
void finalizeAssembly(PETScMatrix &A)
Definition: LinAlg.cpp:163
static const double v
static const double t

References MathLib::LinAlg::finalizeAssembly(), NumLib::VectorProvider::getVector(), NumLib::GlobalVectorProvider::provider, NumLib::VectorProvider::releaseVector(), MathLib::EigenVector::setZero(), MathLib::t, and MathLib::v.

◆ computeKnownSolutions()

void NumLib::TimeDiscretizedODESystem< ODESystemTag::FirstOrderImplicitQuasilinear, NonlinearSolverTag::Newton >::computeKnownSolutions ( GlobalVector const &  x,
int const  process_id 
)
override

Definition at line 151 of file TimeDiscretizedODESystem.cpp.

153{
155 _ode.getKnownSolutions(_time_disc.getCurrentTime(), x, process_id);
156}

◆ getIndicesOfResiduumWithoutInitialCompensation()

std::vector< GlobalIndexType > NumLib::TimeDiscretizedODESystem< ODESystemTag::FirstOrderImplicitQuasilinear, NonlinearSolverTag::Newton >::getIndicesOfResiduumWithoutInitialCompensation ( ) const
inlineoverride
Returns
The global indices for the entries of the global residuum vector that do not need initial non-equilibrium compensation.

Definition at line 92 of file TimeDiscretizedODESystem.h.

93 {
94 return _ode.getIndicesOfResiduumWithoutInitialCompensation();
95 }

◆ getJacobian()

Definition at line 144 of file TimeDiscretizedODESystem.cpp.

145{
146 _mat_trans->computeJacobian(*_Jac, Jac);
147}

◆ getMatrixSpecifications()

Definition at line 130 of file TimeDiscretizedODESystem.h.

132 {
133 return _ode.getMatrixSpecifications(process_id);
134 }

◆ getResidual()

void NumLib::TimeDiscretizedODESystem< ODESystemTag::FirstOrderImplicitQuasilinear, NonlinearSolverTag::Newton >::getResidual ( GlobalVector const &  x_new_timestep,
GlobalVector const &  x_prev,
GlobalVector res 
) const
override

Definition at line 127 of file TimeDiscretizedODESystem.cpp.

130{
131 // TODO Maybe the duplicate calculation of xdot here and in assembleJacobian
132 // can be optimized. However, that would make the interface a bit more
133 // fragile.
135 _time_disc.getXdot(x_new_timestep, x_prev, xdot);
136
137 _mat_trans->computeResidual(*_M, *_K, *_b, x_new_timestep, xdot, res);
138
140}

References NumLib::VectorProvider::getVector(), NumLib::GlobalVectorProvider::provider, and NumLib::VectorProvider::releaseVector().

◆ getTimeDiscretization()

Exposes the used time discretization scheme.

Implements NumLib::TimeDiscretizedODESystemBase< NonlinearSolverTag::Newton >.

Definition at line 129 of file TimeDiscretizedODESystem.h.

129{ return _time_disc; }

◆ isLinear()

Definition at line 117 of file TimeDiscretizedODESystem.h.

117{ return _ode.isLinear(); }

◆ postIteration()

Definition at line 124 of file TimeDiscretizedODESystem.h.

125 {
126 return _ode.postIteration(x);
127 }

◆ preIteration()

void NumLib::TimeDiscretizedODESystem< ODESystemTag::FirstOrderImplicitQuasilinear, NonlinearSolverTag::Newton >::preIteration ( const unsigned  iter,
GlobalVector const &  x 
)
inlineoverride

Definition at line 119 of file TimeDiscretizedODESystem.h.

120 {
121 _ode.preIteration(iter, x);
122 }

◆ updateConstraints()

void NumLib::TimeDiscretizedODESystem< ODESystemTag::FirstOrderImplicitQuasilinear, NonlinearSolverTag::Newton >::updateConstraints ( GlobalVector lower,
GlobalVector upper,
int const  process_id 
)
inlineoverride

Definition at line 111 of file TimeDiscretizedODESystem.h.

113 {
114 _ode.updateConstraints(lower, upper, process_id);
115 }

Member Data Documentation

◆ _b

◆ _b_id

ID of the _b vector.

Definition at line 155 of file TimeDiscretizedODESystem.h.

◆ _Jac

◆ _Jac_id

ID of the _Jac matrix.

Definition at line 152 of file TimeDiscretizedODESystem.h.

◆ _K

◆ _K_id

ID of the _K matrix.

Definition at line 154 of file TimeDiscretizedODESystem.h.

◆ _known_solutions

Initial value:
=
nullptr

stores precomputed values for known solutions

Definition at line 144 of file TimeDiscretizedODESystem.h.

◆ _M

◆ _M_id

ID of the _M matrix.

Definition at line 153 of file TimeDiscretizedODESystem.h.

◆ _mat_trans

the object used to compute the matrix/vector for the nonlinear solver

Definition at line 141 of file TimeDiscretizedODESystem.h.

◆ _ode

◆ _time_disc

the time discretization to being used

Definition at line 138 of file TimeDiscretizedODESystem.h.

◆ _xdot_id

ID of the vector storing xdot in intermediate computations.

Definition at line 158 of file TimeDiscretizedODESystem.h.

◆ _xdot_ids

Definition at line 159 of file TimeDiscretizedODESystem.h.

◆ ODETag


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