NonlinearSystem.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) OpenGeoSys Community (opengeosys.org)
// SPDX-License-Identifier: BSD-3-Clause
 
#pragma once
 
#include "EquationSystem.h"
#include "MathLib/LinAlg/LinAlgEnums.h"
#include "MathLib/LinAlg/LinearSolverBehaviour.h"
#include "Types.h"
 
namespace NumLib
{

template <NonlinearSolverTag NLTag>
class NonlinearSystem;

template <>
class NonlinearSystem<NonlinearSolverTag::Newton> : public EquationSystem
{
public:
    virtual void assemble(std::vector<GlobalVector*> const& x,
                          std::vector<GlobalVector*> const& x_prev,
                          int const process_id) = 0;

    virtual std::vector<GlobalIndexType>
    getIndicesOfResiduumWithoutInitialCompensation() const = 0;
 
    virtual void setReleaseNodalForces(GlobalVector const* /*r_neq*/,
                                       int const /*process_id*/) = 0;

    virtual void getResidual(GlobalVector const& x,
                             GlobalVector const& x_prev,
                             GlobalVector& res) const = 0;

    virtual void getJacobian(GlobalMatrix& Jac) const = 0;

    virtual void computeKnownSolutions(GlobalVector const& x,
                                       int const process_id) = 0;

    virtual void applyKnownSolutions(GlobalVector& x) const = 0;

    virtual void applyKnownSolutionsNewton(
        GlobalMatrix& Jac, GlobalVector& res, GlobalVector const& x,
        GlobalVector& minus_delta_x) const = 0;

    virtual void applyKnownSolutionsPETScSNES(GlobalMatrix& Jac,
                                              GlobalVector& res,
                                              GlobalVector& x) const = 0;
 
    virtual void updateConstraints(GlobalVector& /*lower*/,
                                   GlobalVector& /*upper*/,
                                   int /*process_id*/) = 0;
};

template <>
class NonlinearSystem<NonlinearSolverTag::Picard> : public EquationSystem
{
public:
    virtual void assemble(std::vector<GlobalVector*> const& x,
                          std::vector<GlobalVector*> const& x_prev,
                          int const process_id) = 0;

    virtual std::vector<GlobalIndexType>
    getIndicesOfResiduumWithoutInitialCompensation() const = 0;
 
    virtual void setReleaseNodalForces(GlobalVector const* /*r_neq*/,
                                       int const /*process_id*/) = 0;

    virtual void getA(GlobalMatrix& A) const = 0;

    virtual void getRhs(GlobalVector const& x_prev,
                        GlobalVector& rhs) const = 0;

    virtual void getAandRhsNormalized(GlobalMatrix& A,
                                      GlobalVector& rhs) const = 0;

    virtual void computeKnownSolutions(GlobalVector const& x,
                                       int const process_id) = 0;

    virtual void applyKnownSolutions(GlobalVector& x) const = 0;

    virtual void applyKnownSolutionsPicard(
        GlobalMatrix& A, GlobalVector& rhs, GlobalVector& x,
        MathLib::DirichletBCApplicationMode const mode) const = 0;

    virtual MathLib::LinearSolverBehaviour linearSolverNeedsToCompute()
        const = 0;
};

}  // namespace NumLib