NewtonStepStrategy.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 <vector>
 
#include "MathLib/LinAlg/GlobalMatrixVectorTypes.h"
#include "Types.h"
 
namespace NumLib
{
class DampingPolicy;
template <NonlinearSolverTag NLTag>
class NonlinearSystem;

struct NewtonStepContext
{
    NonlinearSystem<NonlinearSolverTag::Newton>& sys;
    std::vector<GlobalVector*> const& x_prev;
    int process_id;
};

struct StepResult
{
    bool success;

    double step_length;

    bool x_new_is_set;
};

class NewtonStepStrategy
{
public:
    virtual void initialize(GlobalVector const& /*x0*/) {}

    virtual StepResult applyStep(GlobalVector const& x,
                                 GlobalVector const& minus_delta_x,
                                 GlobalVector const& res,
                                 GlobalMatrix const& J,
                                 GlobalVector& x_new,
                                 NewtonStepContext& ctx,
                                 int iteration) = 0;
    void setDampingPolicy(DampingPolicy const* policy)
    {
        _damping_policy = policy;
    }
 
    virtual ~NewtonStepStrategy() = default;
 
protected:
    DampingPolicy const* _damping_policy = nullptr;
};
 
}  // namespace NumLib