Detailed Description

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

See also: ODESystemTag::FirstOrderImplicitQuasilinear

Definition at line 170 of file TimeDiscretizedODESystem.h.

#include <TimeDiscretizedODESystem.h>

Inheritance diagram for NumLib::TimeDiscretizedODESystem< ODESystemTag::FirstOrderImplicitQuasilinear, NonlinearSolverTag::Picard >:

[legend]

Collaboration diagram for NumLib::TimeDiscretizedODESystem< ODESystemTag::FirstOrderImplicitQuasilinear, NonlinearSolverTag::Picard >:

[legend]

Public Types
using	ODE = ODESystem<ODETag, NonlinearSolverTag::Picard>
	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)
	Constructs a new instance.

	~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	getA (GlobalMatrix &A) const override

void	getRhs (GlobalVector const &x_prev, GlobalVector &rhs) const override

void	getAandRhsNormalized (GlobalMatrix &A, GlobalVector &rhs) const override

void	computeKnownSolutions (GlobalVector const &x, int const process_id) override

void	applyKnownSolutions (GlobalVector &x) const override

void	applyKnownSolutionsPicard (GlobalMatrix &A, GlobalVector &rhs, GlobalVector &x) const 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

MathLib::LinearSolverBehaviour	linearSolverNeedsToCompute () const override

Public Member Functions inherited from NumLib::TimeDiscretizedODESystemBase< NonlinearSolverTag::Picard >

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 *	_M
	Matrix \( M \).

GlobalMatrix *	_K
	Matrix \( K \).

GlobalVector *	_b
	Matrix \( b \).

std::size_t	_M_id = 0u
	ID of the `_M` matrix.

std::size_t	_K_id = 0u
	ID of the `_K` matrix.

std::size_t	_b_id = 0u
	ID of the `_b` vector.

Member Typedef Documentation

◆ Index

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

private

Definition at line 276 of file TimeDiscretizedODESystem.h.

◆ MatTrans

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

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

Definition at line 183 of file TimeDiscretizedODESystem.h.

◆ ODE

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

The type of ODE.

Definition at line 180 of file TimeDiscretizedODESystem.h.

◆ TimeDisc

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

A shortcut for a general time discretization scheme.

Definition at line 185 of file TimeDiscretizedODESystem.h.

Constructor & Destructor Documentation

◆ TimeDiscretizedODESystem()

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

explicit

Constructs a new instance.

Definition at line 190 of file TimeDiscretizedODESystem.cpp.

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

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

◆ ~TimeDiscretizedODESystem()

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

override

Definition at line 207 of file TimeDiscretizedODESystem.cpp.

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

References NumLib::GlobalMatrixProvider::provider, NumLib::GlobalVectorProvider::provider, NumLib::MatrixProvider::releaseMatrix(), and NumLib::VectorProvider::releaseVector().

Member Function Documentation

◆ applyKnownSolutions()

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

override

Definition at line 249 of file TimeDiscretizedODESystem.cpp.

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

References detail::applyKnownSolutions().

◆ applyKnownSolutionsPicard()

void NumLib::TimeDiscretizedODESystem< ODESystemTag::FirstOrderImplicitQuasilinear, NonlinearSolverTag::Picard >::applyKnownSolutionsPicard	(	GlobalMatrix &	A,
		GlobalVector &	rhs,
		GlobalVector &	x ) const

override

Definition at line 255 of file TimeDiscretizedODESystem.cpp.

{
    if (!_known_solutions)
    {
        return;
    }
 
    using IndexType = MathLib::MatrixVectorTraits<GlobalMatrix>::Index;
    std::vector<IndexType> ids;
    std::vector<double> values;
    for (auto const& bc : *_known_solutions)
    {
        ids.insert(end(ids), begin(bc.ids), end(bc.ids));
        values.insert(end(values), begin(bc.values), end(bc.values));
    }
    MathLib::applyKnownSolution(A, rhs, x, ids, values);
}

References MathLib::applyKnownSolution().

◆ assemble()

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

override

Definition at line 215 of file TimeDiscretizedODESystem.cpp.

{
    namespace LinAlg = MathLib::LinAlg;
 
    auto const t = _time_disc.getCurrentTime();
    auto const dt = _time_disc.getCurrentTimeIncrement();
    auto const& x_curr = *x_new_timestep[process_id];
 
    _M->setZero();
    _K->setZero();
    _b->setZero();
 
    _ode.preAssemble(t, dt, x_curr);
    _ode.assemble(t, dt, x_new_timestep, x_prev, process_id, *_M, *_K, *_b);
 
    LinAlg::finalizeAssembly(*_M);
    LinAlg::finalizeAssembly(*_K);
    LinAlg::finalizeAssembly(*_b);
}

References MathLib::LinAlg::finalizeAssembly().

◆ computeKnownSolutions()

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

override

Definition at line 240 of file TimeDiscretizedODESystem.cpp.

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

◆ getA()

void NumLib::TimeDiscretizedODESystem< ODESystemTag::FirstOrderImplicitQuasilinear, NonlinearSolverTag::Picard >::getA ( GlobalMatrix & A ) const

inlineoverride

Definition at line 205 of file TimeDiscretizedODESystem.h.

    {
        _mat_trans->computeA(*_M, *_K, A);
    }

◆ getAandRhsNormalized()

void NumLib::TimeDiscretizedODESystem< ODESystemTag::FirstOrderImplicitQuasilinear, NonlinearSolverTag::Picard >::getAandRhsNormalized	(	GlobalMatrix &	A,
		GlobalVector &	rhs ) const

inlineoverride

Definition at line 215 of file TimeDiscretizedODESystem.h.

    {
        _mat_trans->normalizeAandRhs(A, rhs);
    }

◆ getIndicesOfResiduumWithoutInitialCompensation()

std::vector< GlobalIndexType > NumLib::TimeDiscretizedODESystem< ODESystemTag::FirstOrderImplicitQuasilinear, NonlinearSolverTag::Picard >::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 200 of file TimeDiscretizedODESystem.h.

    {
        return _ode.getIndicesOfResiduumWithoutInitialCompensation();
    }

◆ getMatrixSpecifications()

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

inlineoverride

Definition at line 246 of file TimeDiscretizedODESystem.h.

    {
        return _ode.getMatrixSpecifications(process_id);
    }

◆ getRhs()

void NumLib::TimeDiscretizedODESystem< ODESystemTag::FirstOrderImplicitQuasilinear, NonlinearSolverTag::Picard >::getRhs	(	GlobalVector const &	x_prev,
		GlobalVector &	rhs ) const

inlineoverride

Definition at line 210 of file TimeDiscretizedODESystem.h.

    {
        _mat_trans->computeRhs(*_M, *_K, *_b, x_prev, rhs);
    }

◆ getTimeDiscretization()

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

inlineoverridevirtual

Exposes the used time discretization scheme.

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

Definition at line 245 of file TimeDiscretizedODESystem.h.

245{ return _time_disc; }

◆ isLinear()

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

inlineoverride

Definition at line 228 of file TimeDiscretizedODESystem.h.

228{ return _ode.isLinear(); }

◆ linearSolverNeedsToCompute()

MathLib::LinearSolverBehaviour NumLib::TimeDiscretizedODESystem< ODESystemTag::FirstOrderImplicitQuasilinear, NonlinearSolverTag::Picard >::linearSolverNeedsToCompute ( ) const

inlineoverride

Definition at line 252 of file TimeDiscretizedODESystem.h.

    {
        if (_ode.shouldLinearSolverComputeOnlyUponTimestepChange() &&
            _time_disc.getCurrentTimeIncrement() !=
                _time_disc.getPreviousTimeIncrement())
        {
            return MathLib::LinearSolverBehaviour::RECOMPUTE_AND_STORE;
        }
        if (_ode.shouldLinearSolverComputeOnlyUponTimestepChange() &&
            _time_disc.getCurrentTimeIncrement() ==
                _time_disc.getPreviousTimeIncrement())
        {
            return MathLib::LinearSolverBehaviour::REUSE;
        }
        return MathLib::LinearSolverBehaviour::RECOMPUTE;
    }

References MathLib::RECOMPUTE, MathLib::RECOMPUTE_AND_STORE, and MathLib::REUSE.

◆ postIteration()

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

inlineoverride

Definition at line 240 of file TimeDiscretizedODESystem.h.

    {
        return _ode.postIteration(x);
    }

◆ preIteration()

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

inlineoverride

Definition at line 235 of file TimeDiscretizedODESystem.h.

    {
        _ode.preIteration(iter, x);
    }

◆ requiresNormalization()

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

inlineoverride

Definition at line 230 of file TimeDiscretizedODESystem.h.

    {
        return _ode.requiresNormalization();
    }

Member Data Documentation

◆ _b

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

private

Matrix \( b \).

Definition at line 282 of file TimeDiscretizedODESystem.h.

◆ _b_id

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

private

ID of the _b vector.

Definition at line 286 of file TimeDiscretizedODESystem.h.

◆ _K

GlobalMatrix* NumLib::TimeDiscretizedODESystem< ODESystemTag::FirstOrderImplicitQuasilinear, NonlinearSolverTag::Picard >::_K

private

Matrix \( K \).

Definition at line 281 of file TimeDiscretizedODESystem.h.

◆ _K_id

std::size_t NumLib::TimeDiscretizedODESystem< ODESystemTag::FirstOrderImplicitQuasilinear, NonlinearSolverTag::Picard >::_K_id = 0u

private

ID of the _K matrix.

Definition at line 285 of file TimeDiscretizedODESystem.h.

◆ _known_solutions

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

private

Initial value:

=

nullptr

stores precomputed values for known solutions

Definition at line 277 of file TimeDiscretizedODESystem.h.

◆ _M

GlobalMatrix* NumLib::TimeDiscretizedODESystem< ODESystemTag::FirstOrderImplicitQuasilinear, NonlinearSolverTag::Picard >::_M

private

Matrix \( M \).

Definition at line 280 of file TimeDiscretizedODESystem.h.

◆ _M_id

std::size_t NumLib::TimeDiscretizedODESystem< ODESystemTag::FirstOrderImplicitQuasilinear, NonlinearSolverTag::Picard >::_M_id = 0u

private

ID of the _M matrix.

Definition at line 284 of file TimeDiscretizedODESystem.h.

◆ _mat_trans

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

private

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

Definition at line 274 of file TimeDiscretizedODESystem.h.

◆ _ode

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

private

ode the ODE being wrapped

Definition at line 270 of file TimeDiscretizedODESystem.h.

◆ _time_disc

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

private

the time discretization to being used

Definition at line 271 of file TimeDiscretizedODESystem.h.

◆ ODETag

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

static

Initial value:

=

ODESystemTag::FirstOrderImplicitQuasilinear

NumLib::ODESystemTag::FirstOrderImplicitQuasilinear

@ FirstOrderImplicitQuasilinear

A tag indicating the type of ODE.

Definition at line 176 of file TimeDiscretizedODESystem.h.

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

NumLib/ODESolver/TimeDiscretizedODESystem.h
NumLib/ODESolver/TimeDiscretizedODESystem.cpp

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

◆ applyKnownSolutionsPicard()

◆ assemble()

◆ computeKnownSolutions()

◆ getA()

◆ getAandRhsNormalized()

◆ getIndicesOfResiduumWithoutInitialCompensation()

◆ getMatrixSpecifications()

◆ getRhs()

◆ getTimeDiscretization()

◆ isLinear()

◆ linearSolverNeedsToCompute()

◆ postIteration()

◆ preIteration()

◆ requiresNormalization()

Member Data Documentation

◆ _b

◆ _b_id

◆ _K

◆ _K_id

◆ _known_solutions

◆ _M

◆ _M_id

◆ _mat_trans

◆ _ode

◆ _time_disc

◆ ODETag