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.
using	MatTrans = MatrixTranslator<ODETag>
using	TimeDisc = TimeDiscretization
	A shortcut for a general time discretization scheme.

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< GlobalIndexType >	getIndicesOfResiduumWithoutInitialCompensation () const override
void	setReleaseNodalForces (GlobalVector const *r_neq, int const process_id) 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 const &x, GlobalVector &minus_delta_x) const override
void	applyKnownSolutionsPETScSNES (GlobalMatrix &Jac, GlobalVector &res, GlobalVector &x) const override
void	updateConstraints (GlobalVector &lower, GlobalVector &upper, int const process_id) override
bool	isLinear () const override
bool	requiresNormalization () const override
void	preIteration (const unsigned iter, GlobalVector const &x) override
IterationResult	postIteration (GlobalVector const &x) override
TimeDisc &	getTimeDiscretization () override
	Exposes the used time discretization scheme.
MathLib::MatrixSpecifications	getMatrixSpecifications (const int process_id) const override

Static Public Attributes
static const ODESystemTag	ODETag
	A tag indicating the type of ODE.

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

Private Attributes
ODE &	_ode
	ode the ODE being wrapped
TimeDisc &	_time_disc
	the time discretization to being used
std::unique_ptr< MatTrans >	_mat_trans
	the object used to compute the matrix/vector for the nonlinear solver
std::vector< NumLib::IndexValueVector< Index > > const *	_known_solutions
	stores precomputed values for known solutions
GlobalMatrix *	_Jac
	the Jacobian of the residual
GlobalVector *	_b
	Matrix \( b \).
std::size_t	_Jac_id = 0u
	ID of the `_Jac` matrix.
std::size_t	_b_id = 0u
	ID of the `_b` vector.

Member Typedef Documentation

◆ Index

using NumLib::TimeDiscretizedODESystem< ODESystemTag::FirstOrderImplicitQuasilinear, NonlinearSolverTag::Newton >::Index = MathLib::MatrixVectorTraits<GlobalMatrix>::Index

private

Definition at line 158 of file TimeDiscretizedODESystem.h.

◆ MatTrans

using NumLib::TimeDiscretizedODESystem< ODESystemTag::FirstOrderImplicitQuasilinear, NonlinearSolverTag::Newton >::MatTrans = MatrixTranslator<ODETag>

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

Definition at line 70 of file TimeDiscretizedODESystem.h.

◆ ODE

using NumLib::TimeDiscretizedODESystem< ODESystemTag::FirstOrderImplicitQuasilinear, NonlinearSolverTag::Newton >::ODE = ODESystem<ODETag, NonlinearSolverTag::Newton>

The type of ODE.

Definition at line 67 of file TimeDiscretizedODESystem.h.

◆ TimeDisc

using NumLib::TimeDiscretizedODESystem< ODESystemTag::FirstOrderImplicitQuasilinear, NonlinearSolverTag::Newton >::TimeDisc = TimeDiscretization

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_id	ID of the ODE to be solved.
ode	the ODE to be wrapped.
time_discretization	the time discretization to be used.

Definition at line 49 of file TimeDiscretizedODESystem.cpp.

    : _ode(ode),
      _time_disc(time_discretization),
      _mat_trans(createMatrixTranslator<ODETag>(time_discretization))
{
    _Jac = &NumLib::GlobalMatrixProvider::provider.getMatrix(
        _ode.getMatrixSpecifications(process_id), _Jac_id);
    _b = &NumLib::GlobalVectorProvider::provider.getVector(
        _ode.getMatrixSpecifications(process_id), _b_id);
}

References _b, _b_id, _Jac, _Jac_id, _mat_trans, _ode, _time_disc, NumLib::createMatrixTranslator(), NumLib::Newton, ODETag, NumLib::GlobalMatrixProvider::provider, and NumLib::GlobalVectorProvider::provider.

◆ ~TimeDiscretizedODESystem()

NumLib::TimeDiscretizedODESystem< ODESystemTag::FirstOrderImplicitQuasilinear, NonlinearSolverTag::Newton >::~TimeDiscretizedODESystem ( )

override

Definition at line 64 of file TimeDiscretizedODESystem.cpp.

{
    NumLib::GlobalMatrixProvider::provider.releaseMatrix(*_Jac);
    NumLib::GlobalVectorProvider::provider.releaseVector(*_b);
}

References ~TimeDiscretizedODESystem(), _b, _Jac, NumLib::Newton, NumLib::GlobalMatrixProvider::provider, and NumLib::GlobalVectorProvider::provider.

Referenced by ~TimeDiscretizedODESystem().

Member Function Documentation

◆ applyKnownSolutions()

void NumLib::TimeDiscretizedODESystem< ODESystemTag::FirstOrderImplicitQuasilinear, NonlinearSolverTag::Newton >::applyKnownSolutions ( GlobalVector & x ) const

override

Definition at line 126 of file TimeDiscretizedODESystem.cpp.

{
    ::detail::applyKnownSolutions(_known_solutions, x);
}

References _known_solutions, detail::applyKnownSolutions(), applyKnownSolutions(), and NumLib::Newton.

Referenced by applyKnownSolutions().

◆ applyKnownSolutionsNewton()

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

override

Definition at line 132 of file TimeDiscretizedODESystem.cpp.

{
    if (!_known_solutions)
    {
        return;
    }
 
    using IndexType = MathLib::MatrixVectorTraits<GlobalMatrix>::Index;
    std::size_t const size = ranges::accumulate(
        *_known_solutions | ranges::views::transform([](auto const& bc)
                                                     { return bc.ids.size(); }),
        0);
    std::vector<IndexType> ids;
    ids.reserve(size);
    std::vector<double> values;
    values.reserve(size);
 
    for (auto const& bc : *_known_solutions)
    {
        for (std::size_t i = 0; i < bc.ids.size(); ++i)
        {
            auto const id = bc.ids[i];
            ids.push_back(id);
            // minus_delta_x will be set to the difference between the current
            // value and the Dirichlet BC value.
            values.push_back(x[id] - bc.values[i]);
        }
    }
 
    MathLib::applyKnownSolution(
        Jac, res, minus_delta_x, ids, values,
        MathLib::DirichletBCApplicationMode::COMPLETE_MATRIX_UPDATE);
}

References _known_solutions, MathLib::applyKnownSolution(), MathLib::COMPLETE_MATRIX_UPDATE, and NumLib::Newton.

◆ applyKnownSolutionsPETScSNES()

void NumLib::TimeDiscretizedODESystem< ODESystemTag::FirstOrderImplicitQuasilinear, NonlinearSolverTag::Newton >::applyKnownSolutionsPETScSNES	(	GlobalMatrix &	Jac,
		GlobalVector &	res,
		GlobalVector &	x ) const

override

Definition at line 170 of file TimeDiscretizedODESystem.cpp.

{
    if (!_known_solutions)
    {
        return;
    }
 
    using IndexType = MathLib::MatrixVectorTraits<GlobalMatrix>::Index;
    std::vector<IndexType> ids;
    for (auto const& bc : *_known_solutions)
    {
        ids.insert(end(ids), begin(bc.ids), end(bc.ids));
    }
 
    // For the Newton method the values must be zero
    std::vector<double> values(ids.size(), 0);
    MathLib::applyKnownSolution(
        Jac, res, x, ids, values,
        MathLib::DirichletBCApplicationMode::COMPLETE_MATRIX_UPDATE);
}

References _known_solutions, MathLib::applyKnownSolution(), MathLib::COMPLETE_MATRIX_UPDATE, and NumLib::Newton.

◆ 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 71 of file TimeDiscretizedODESystem.cpp.

{
    auto const t = _time_disc.getCurrentTime();
    auto const dt = _time_disc.getCurrentTimeIncrement();
    auto const& x_curr = *x_new_timestep[process_id];
 
    _b->setZero();
    _Jac->setZero();
    try
    {
        _ode.preAssemble(t, dt, x_curr);
        _ode.assembleWithJacobian(t, dt, x_new_timestep, x_prev, process_id,
                                  *_b, *_Jac);
    }
    catch (AssemblyException const&)
    {
        MathLib::LinAlg::finalizeAssembly(*_b);
        MathLib::LinAlg::finalizeAssembly(*_Jac);
        throw;
    }
    MathLib::LinAlg::finalizeAssembly(*_b);
    MathLib::LinAlg::finalizeAssembly(*_Jac);
}

References _b, _Jac, _ode, _time_disc, MathLib::LinAlg::finalizeAssembly(), and NumLib::Newton.

◆ computeKnownSolutions()

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

override

Definition at line 117 of file TimeDiscretizedODESystem.cpp.

{
    _known_solutions =
        _ode.getKnownSolutions(_time_disc.getCurrentTime(), x, process_id);
}

References _known_solutions, _ode, _time_disc, computeKnownSolutions(), and NumLib::Newton.

Referenced by computeKnownSolutions().

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

    {
        return _ode.getIndicesOfResiduumWithoutInitialCompensation();
    }

References _ode.

◆ getJacobian()

void NumLib::TimeDiscretizedODESystem< ODESystemTag::FirstOrderImplicitQuasilinear, NonlinearSolverTag::Newton >::getJacobian ( GlobalMatrix & Jac ) const

override

Definition at line 110 of file TimeDiscretizedODESystem.cpp.

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

References _Jac, _mat_trans, getJacobian(), and NumLib::Newton.

Referenced by getJacobian().

◆ getMatrixSpecifications()

MathLib::MatrixSpecifications NumLib::TimeDiscretizedODESystem< ODESystemTag::FirstOrderImplicitQuasilinear, NonlinearSolverTag::Newton >::getMatrixSpecifications ( const int process_id ) const

inlineoverride

Definition at line 145 of file TimeDiscretizedODESystem.h.

    {
        return _ode.getMatrixSpecifications(process_id);
    }

References _ode.

◆ 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 99 of file TimeDiscretizedODESystem.cpp.

{
    MathLib::LinAlg::copy(*_b, res);   // res = b
    MathLib::LinAlg::scale(res, -1.);  // res = -b
}

References _b, MathLib::LinAlg::copy(), NumLib::Newton, and MathLib::LinAlg::scale().

◆ getTimeDiscretization()

TimeDisc & NumLib::TimeDiscretizedODESystem< ODESystemTag::FirstOrderImplicitQuasilinear, NonlinearSolverTag::Newton >::getTimeDiscretization ( )

inlineoverridevirtual

Exposes the used time discretization scheme.

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

Definition at line 144 of file TimeDiscretizedODESystem.h.

144{ return _time_disc; }

References _time_disc.

◆ isLinear()

bool NumLib::TimeDiscretizedODESystem< ODESystemTag::FirstOrderImplicitQuasilinear, NonlinearSolverTag::Newton >::isLinear ( ) const

inlineoverride

Definition at line 127 of file TimeDiscretizedODESystem.h.

127{ return _ode.isLinear(); }

References _ode.

◆ postIteration()

IterationResult NumLib::TimeDiscretizedODESystem< ODESystemTag::FirstOrderImplicitQuasilinear, NonlinearSolverTag::Newton >::postIteration ( GlobalVector const & x )

inlineoverride

Definition at line 139 of file TimeDiscretizedODESystem.h.

    {
        return _ode.postIteration(x);
    }

References _ode.

◆ preIteration()

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

inlineoverride

Definition at line 134 of file TimeDiscretizedODESystem.h.

    {
        _ode.preIteration(iter, x);
    }

References _ode.

◆ requiresNormalization()

bool NumLib::TimeDiscretizedODESystem< ODESystemTag::FirstOrderImplicitQuasilinear, NonlinearSolverTag::Newton >::requiresNormalization ( ) const

inlineoverride

Definition at line 129 of file TimeDiscretizedODESystem.h.

    {
        return _ode.requiresNormalization();
    }

References _ode.

◆ setReleaseNodalForces()

void NumLib::TimeDiscretizedODESystem< ODESystemTag::FirstOrderImplicitQuasilinear, NonlinearSolverTag::Newton >::setReleaseNodalForces	(	GlobalVector const *	r_neq,
		int const	process_id )

inlineoverride

Definition at line 97 of file TimeDiscretizedODESystem.h.

    {
        _ode.setReleaseNodalForces(r_neq, process_id);
    }

References _ode.

◆ updateConstraints()

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

inlineoverride

Definition at line 121 of file TimeDiscretizedODESystem.h.

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

References _ode.

Member Data Documentation

◆ _b

GlobalVector* NumLib::TimeDiscretizedODESystem< ODESystemTag::FirstOrderImplicitQuasilinear, NonlinearSolverTag::Newton >::_b

private

Matrix \( b \).

Definition at line 163 of file TimeDiscretizedODESystem.h.

Referenced by TimeDiscretizedODESystem(), ~TimeDiscretizedODESystem(), assemble(), and getResidual().

◆ _b_id

std::size_t NumLib::TimeDiscretizedODESystem< ODESystemTag::FirstOrderImplicitQuasilinear, NonlinearSolverTag::Newton >::_b_id = 0u

private

ID of the _b vector.

Definition at line 166 of file TimeDiscretizedODESystem.h.

Referenced by TimeDiscretizedODESystem().

◆ _Jac

GlobalMatrix* NumLib::TimeDiscretizedODESystem< ODESystemTag::FirstOrderImplicitQuasilinear, NonlinearSolverTag::Newton >::_Jac

private

the Jacobian of the residual

Definition at line 162 of file TimeDiscretizedODESystem.h.

Referenced by TimeDiscretizedODESystem(), ~TimeDiscretizedODESystem(), assemble(), and getJacobian().

◆ _Jac_id

std::size_t NumLib::TimeDiscretizedODESystem< ODESystemTag::FirstOrderImplicitQuasilinear, NonlinearSolverTag::Newton >::_Jac_id = 0u

private

ID of the _Jac matrix.

Definition at line 165 of file TimeDiscretizedODESystem.h.

Referenced by TimeDiscretizedODESystem().

◆ _known_solutions

std::vector<NumLib::IndexValueVector<Index> > const* NumLib::TimeDiscretizedODESystem< ODESystemTag::FirstOrderImplicitQuasilinear, NonlinearSolverTag::Newton >::_known_solutions

private

Initial value:

=

nullptr

stores precomputed values for known solutions

Definition at line 159 of file TimeDiscretizedODESystem.h.

Referenced by applyKnownSolutions(), applyKnownSolutionsNewton(), applyKnownSolutionsPETScSNES(), and computeKnownSolutions().

◆ _mat_trans

std::unique_ptr<MatTrans> NumLib::TimeDiscretizedODESystem< ODESystemTag::FirstOrderImplicitQuasilinear, NonlinearSolverTag::Newton >::_mat_trans

private

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

Definition at line 156 of file TimeDiscretizedODESystem.h.

Referenced by TimeDiscretizedODESystem(), and getJacobian().

◆ _ode

ODE& NumLib::TimeDiscretizedODESystem< ODESystemTag::FirstOrderImplicitQuasilinear, NonlinearSolverTag::Newton >::_ode

private

ode the ODE being wrapped

Definition at line 152 of file TimeDiscretizedODESystem.h.

Referenced by TimeDiscretizedODESystem(), assemble(), computeKnownSolutions(), getIndicesOfResiduumWithoutInitialCompensation(), getMatrixSpecifications(), isLinear(), postIteration(), preIteration(), requiresNormalization(), setReleaseNodalForces(), and updateConstraints().

◆ _time_disc

TimeDisc& NumLib::TimeDiscretizedODESystem< ODESystemTag::FirstOrderImplicitQuasilinear, NonlinearSolverTag::Newton >::_time_disc

private

the time discretization to being used

Definition at line 153 of file TimeDiscretizedODESystem.h.

Referenced by TimeDiscretizedODESystem(), assemble(), computeKnownSolutions(), and getTimeDiscretization().

◆ ODETag

const ODESystemTag NumLib::TimeDiscretizedODESystem< ODESystemTag::FirstOrderImplicitQuasilinear, NonlinearSolverTag::Newton >::ODETag

static

Initial value:

=

ODESystemTag::FirstOrderImplicitQuasilinear

NumLib::ODESystemTag::FirstOrderImplicitQuasilinear

@ FirstOrderImplicitQuasilinear

Definition Types.h:34

A tag indicating the type of ODE.

Definition at line 63 of file TimeDiscretizedODESystem.h.

Referenced by TimeDiscretizedODESystem().

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

Detailed Description

Public Types

Public Member Functions

Static Public Attributes

Private Types

Private Attributes

Member Typedef Documentation

◆ Index

◆ MatTrans

◆ ODE

◆ TimeDisc

Constructor & Destructor Documentation

◆ TimeDiscretizedODESystem()

◆ ~TimeDiscretizedODESystem()

Member Function Documentation

◆ applyKnownSolutions()

◆ applyKnownSolutionsNewton()

◆ applyKnownSolutionsPETScSNES()

◆ assemble()

◆ computeKnownSolutions()

◆ getIndicesOfResiduumWithoutInitialCompensation()

◆ getJacobian()

◆ getMatrixSpecifications()

◆ getResidual()

◆ getTimeDiscretization()

◆ isLinear()

◆ postIteration()

◆ preIteration()

◆ requiresNormalization()

◆ setReleaseNodalForces()

◆ updateConstraints()

Member Data Documentation

◆ _b

◆ _b_id

◆ _Jac

◆ _Jac_id

◆ _known_solutions

◆ _mat_trans

◆ _ode

◆ _time_disc

◆ ODETag