NumLib::MatrixTranslatorForwardEuler< ODESystemTag::FirstOrderImplicitQuasilinear > Class Template Reference

Detailed Description

template<>
class NumLib::MatrixTranslatorForwardEuler< ODESystemTag::FirstOrderImplicitQuasilinear >

GlobalMatrix translator for first order implicit quasi-linear ODEs, used with the ForwardEuler scheme.

See also

ODESystemTag::FirstOrderImplicitQuasilinear

Remarks

You might also want read the remarks on time discretization.

Definition at line 155 of file MatrixTranslator.h.

#include <MatrixTranslator.h>

Inheritance diagram for NumLib::MatrixTranslatorForwardEuler< ODESystemTag::FirstOrderImplicitQuasilinear >:

Collaboration diagram for NumLib::MatrixTranslatorForwardEuler< ODESystemTag::FirstOrderImplicitQuasilinear >:

Public Member Functions
	MatrixTranslatorForwardEuler (ForwardEuler const &timeDisc)
void	computeA (GlobalMatrix const &M, GlobalMatrix const &, GlobalMatrix &A) const override
	Computes \( A = M \cdot \alpha \). More...
void	computeRhs (const GlobalMatrix &M, const GlobalMatrix &K, const GlobalVector &b, GlobalVector &rhs) const override
	Computes \( \mathtt{rhs} = M \cdot x_O - K \cdot x_O + b \). More...
void	computeResidual (GlobalMatrix const &M, GlobalMatrix const &K, GlobalVector const &b, GlobalVector const &x_new_timestep, GlobalVector const &xdot, GlobalVector &res) const override
	Computes \( r = M \cdot \hat x + K \cdot x_C - b \). More...
void	computeJacobian (GlobalMatrix const &Jac_in, GlobalMatrix &Jac_out) const override
Public Member Functions inherited from NumLib::MatrixTranslator< ODESystemTag::FirstOrderImplicitQuasilinear >
virtual void	pushMatrices (GlobalMatrix const &, GlobalMatrix const &, GlobalVector const &)
virtual	~MatrixTranslator ()=default

Private Attributes
ForwardEuler const &	_fwd_euler
	the time discretization used. More...
std::size_t	_tmp_id = 0u
	ID of the vector storing intermediate computations. More...

Constructor & Destructor Documentation

MatrixTranslatorForwardEuler()

NumLib::MatrixTranslatorForwardEuler< ODESystemTag::FirstOrderImplicitQuasilinear >::MatrixTranslatorForwardEuler ( ForwardEuler const &  timeDisc )

inlineexplicit

Constructs a new instance.

Parameters

timeDisc

the time discretization scheme to be used.

Definition at line 163 of file MatrixTranslator.h.

        : _fwd_euler(timeDisc)
    {
    }

Member Function Documentation

computeA()

void NumLib::MatrixTranslatorForwardEuler< ODESystemTag::FirstOrderImplicitQuasilinear >::computeA ( GlobalMatrix const &  M, GlobalMatrix const &  , GlobalMatrix &  A  ) const

overridevirtual

Computes \( A = M \cdot \alpha \).

Implements NumLib::MatrixTranslator< ODESystemTag::FirstOrderImplicitQuasilinear >.

Definition at line 70 of file MatrixTranslator.cpp.

References MathLib::LinAlg::copy(), and MathLib::LinAlg::scale().

{
    namespace LinAlg = MathLib::LinAlg;

    auto const dxdot_dx = _fwd_euler.getNewXWeight();

    // A = M * dxdot_dx
    LinAlg::copy(M, A);
    LinAlg::scale(A, dxdot_dx);
}

computeJacobian()

void NumLib::MatrixTranslatorForwardEuler< ODESystemTag::FirstOrderImplicitQuasilinear >::computeJacobian ( GlobalMatrix const &  Jac_in, GlobalMatrix &  Jac_out  ) const

overridevirtual

Writes Jac_in to Jac_out.

Todo:

Do not copy.

Implements NumLib::MatrixTranslator< ODESystemTag::FirstOrderImplicitQuasilinear >.

Definition at line 117 of file MatrixTranslator.cpp.

References MathLib::LinAlg::copy(), and NumLib::FirstOrderImplicitQuasilinear.

{
    namespace LinAlg = MathLib::LinAlg;

    LinAlg::copy(Jac_in, Jac_out);
}

computeResidual()

void NumLib::MatrixTranslatorForwardEuler< ODESystemTag::FirstOrderImplicitQuasilinear >::computeResidual ( GlobalMatrix const &  M, GlobalMatrix const &  K, GlobalVector const &  b, GlobalVector const &  x_new_timestep, GlobalVector const &  xdot, GlobalVector &  res  ) const

overridevirtual

Computes \( r = M \cdot \hat x + K \cdot x_C - b \).

Implements NumLib::MatrixTranslator< ODESystemTag::FirstOrderImplicitQuasilinear >.

Definition at line 102 of file MatrixTranslator.cpp.

References MathLib::LinAlg::axpy(), MathLib::LinAlg::matMult(), and MathLib::LinAlg::matMultAdd().

{
    namespace LinAlg = MathLib::LinAlg;

    auto const& x_curr = _fwd_euler.getCurrentX(x_new_timestep);

    // res = M * x_dot + K * x_curr - b
    LinAlg::matMult(M, xdot, res);
    LinAlg::matMultAdd(K, x_curr, res, res);
    LinAlg::axpy(res, -1.0, b);
}

computeRhs()

void NumLib::MatrixTranslatorForwardEuler< ODESystemTag::FirstOrderImplicitQuasilinear >::computeRhs ( const GlobalMatrix &  M, const GlobalMatrix &  K, const GlobalVector &  b, GlobalVector &  rhs  ) const

overridevirtual

Computes \( \mathtt{rhs} = M \cdot x_O - K \cdot x_O + b \).

Implements NumLib::MatrixTranslator< ODESystemTag::FirstOrderImplicitQuasilinear >.

Definition at line 83 of file MatrixTranslator.cpp.

References MathLib::LinAlg::aypx(), NumLib::VectorProvider::getVector(), MathLib::LinAlg::matMult(), MathLib::LinAlg::matMultAdd(), NumLib::GlobalVectorProvider::provider, and NumLib::VectorProvider::releaseVector().

{
    namespace LinAlg = MathLib::LinAlg;

    auto& tmp = NumLib::GlobalVectorProvider::provider.getVector(_tmp_id);
    _fwd_euler.getWeightedOldX(tmp);

    auto const& x_old = _fwd_euler.getXOld();

    // rhs = b + M * weighted_old_x - K * x_old
    LinAlg::matMult(K, x_old, rhs);        // rhs = K * x_old
    LinAlg::aypx(rhs, -1.0, b);            // rhs = b - K * x_old
    LinAlg::matMultAdd(M, tmp, rhs, rhs);  // rhs += M * weighted_old_x

    NumLib::GlobalVectorProvider::provider.releaseVector(tmp);
}

Member Data Documentation

_fwd_euler

ForwardEuler const& NumLib::MatrixTranslatorForwardEuler< ODESystemTag::FirstOrderImplicitQuasilinear >::_fwd_euler

private

the time discretization used.

Definition at line 189 of file MatrixTranslator.h.

_tmp_id

std::size_t NumLib::MatrixTranslatorForwardEuler< ODESystemTag::FirstOrderImplicitQuasilinear >::_tmp_id = 0u

mutableprivate

ID of the vector storing intermediate computations.

Definition at line 192 of file MatrixTranslator.h.

---

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

• NumLib/ODESolver/MatrixTranslator.h
• NumLib/ODESolver/MatrixTranslator.cpp