PETScNonlinearSolver.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) OpenGeoSys Community (opengeosys.org)
// SPDX-License-Identifier: BSD-3-Clause
 
#pragma once
#ifdef USE_PETSC
 
#include <petscsnes.h>
 
#include "ConvergenceCriterion.h"
#include "NonlinearSolver.h"
#include "TimeDiscretizedODESystem.h"
 
namespace NumLib
{
class PETScNonlinearSolver final : public NonlinearSolverBase
{
public:
    using System = NonlinearSystem<NonlinearSolverTag::Newton>;

    PETScNonlinearSolver(GlobalLinearSolver& linear_solver,
                         int maxiter,
                         std::string prefix);

    void setEquationSystem(System& eq, ConvergenceCriterion& conv_crit);
 
    void compensateNonEquilibriumInitialResiduum(bool const value);
 
    void calculateNonEquilibriumInitialResiduum(
        std::vector<GlobalVector*> const& x,
        std::vector<GlobalVector*> const& x_prev,
        int const process_id) override;
 
    NonlinearSolverStatus solve(
        std::vector<GlobalVector*>& x,
        std::vector<GlobalVector*> const& x_prev,
        std::function<void(int, bool, std::vector<GlobalVector*> const&)> const&
            postIterationCallback,
        int const process_id) override;
 
private:
    SNES _snes_solver;
 
    System* _equation_system = nullptr;
    ConvergenceCriterion* _convergence_criterion = nullptr;
 
    std::size_t _residual_id = 0u;  
    std::size_t _jacobian_id = 0u;  
 
    std::size_t _petsc_x_id = 0u;
    std::size_t _petsc_jacobian_id = 0u;
    std::size_t _petsc_residual_id = 0u;
 
    // clang-format off
    bool _compensate_non_equilibrium_initial_residuum = false;
    // clang-format on
};

 
}  // namespace NumLib
#endif  // USE_PETSC