EquationSystem.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 "MathLib/LinAlg/MatrixSpecifications.h"
 
namespace NumLib
{

enum class IterationResult : char
{
    SUCCESS,
    FAILURE,
    REPEAT_ITERATION
};

class EquationSystem
{
public:
    virtual bool isLinear() const = 0;

    virtual bool requiresNormalization() const = 0;

    virtual void preIteration(const unsigned iter, GlobalVector const& x)
    {
        (void)iter;
        (void)x;  // by default do nothing
    }

    virtual IterationResult postIteration(GlobalVector const& x)
    {
        (void)x;  // by default do nothing
        return IterationResult::SUCCESS;
    }
 
    virtual MathLib::MatrixSpecifications getMatrixSpecifications(
        const int process_id) const = 0;
 
    virtual ~EquationSystem() = default;
};

}  // namespace NumLib