nrsolver.h

Go to the documentation of this file.

/*
 *
 *                 #####    #####   ######  ######  ###   ###
 *               ##   ##  ##   ##  ##      ##      ## ### ##
 *              ##   ##  ##   ##  ####    ####    ##  #  ##
 *             ##   ##  ##   ##  ##      ##      ##     ##
 *            ##   ##  ##   ##  ##      ##      ##     ##
 *            #####    #####   ##      ######  ##     ##
 *
 *
 *             OOFEM : Object Oriented Finite Element Code
 *
 *               Copyright (C) 1993 - 2025   Borek Patzak
 *
 *
 *
 *       Czech Technical University, Faculty of Civil Engineering,
 *   Department of Structural Mechanics, 166 29 Prague, Czech Republic
 *
 *  This library is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU Lesser General Public
 *  License as published by the Free Software Foundation; either
 *  version 2.1 of the License, or (at your option) any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *  Lesser General Public License for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public
 *  License along with this library; if not, write to the Free Software
 *  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 */
 
 
#ifndef nrsolver_h
#define nrsolver_h
 
#include <set>
#include <vector>
 
#include "sparselinsystemnm.h"
#include "sparsenonlinsystemnm.h"
#include "sparsemtrx.h"
#include "floatarray.h"
#include "linesearch.h"
#include "convergedreason.h"
 
#include <memory>
#include <map>


#define _IFT_NRSolver_Name "nrsolver"
#define _IFT_NRSolver_maxiter "maxiter"
#define _IFT_NRSolver_miniterations "miniter"
#define _IFT_NRSolver_minsteplength "minsteplength"
#define _IFT_NRSolver_manrmsteps "manrmsteps"
#define _IFT_NRSolver_lstype "lstype"
#define _IFT_NRSolver_ddm "ddm"
#define _IFT_NRSolver_ddv "ddv"
#define _IFT_NRSolver_ddfunc "ddltf"
#define _IFT_NRSolver_linesearch "linesearch"
#define _IFT_NRSolver_rtolv "rtolv"
#define _IFT_NRSolver_rtolf "rtolf"
#define _IFT_NRSolver_rtold "rtold"
#define _IFT_NRSolver_calcstiffbeforeres "calcstiffbeforeres"
#define _IFT_NRSolver_constrainedNRalpha "constrainednralpha"
#define _IFT_NRSolver_constrainedNRminiter "constrainednrminiter"
#define _IFT_NRSolver_maxinc "maxinc"
#define _IFT_NRSolver_forceScale "forcescale"
#define _IFT_NRSolver_forceScaleDofs "forcescaledofs"
#define _IFT_NRSolver_solutionDependentExternalForces "soldepextforces"
 
namespace oofem {
class Domain;
class EngngModel;

class OOFEM_EXPORT NRSolver : public SparseNonLinearSystemNM
{
protected:
    enum nrsolver_ModeType { nrsolverModifiedNRM, nrsolverFullNRM, nrsolverAccelNRM };
 
    int nsmax, minIterations;
    double minStepLength;
    nrsolver_ModeType NR_Mode, NR_OldMode;
    int NR_ModeTick;
    int MANRMSteps;

    std :: unique_ptr< SparseLinearSystemNM >linSolver;
    LinSystSolverType solverType;
    SparseMtrx :: SparseMtrxVersionType smConstraintVersion;
    int numberOfPrescribedDofs;
    bool prescribedDofsFlag;

    IntArray prescribedDofs;
    FloatArray prescribedDofsValues;
    int prescribedDisplacementTF;
    IntArray prescribedEqs;
    bool prescribedEqsInitFlag;
    FloatArray lastReactions;
    bool lsFlag;
    std :: unique_ptr< LineSearchNM >linesearchSolver;
    bool mCalcStiffBeforeRes;
    bool constrainedNRFlag;
    double constrainedNRalpha;
    int constrainedNRminiter;

    FloatArray rtolf;
    FloatArray rtold;

    FloatArray forceErrVec;
    FloatArray forceErrVecOld;

    bool solutionDependentExternalForcesFlag;
 
 

    std :: map< int, double >dg_forceScale;
 
    double maxIncAllowed;
public:
    NRSolver(Domain *d, EngngModel *m);
    virtual ~NRSolver();
 
    // Overloaded methods:
    ConvergedReason solve(SparseMtrx &k, FloatArray &R, FloatArray *R0,
                    FloatArray &X, FloatArray &dX, FloatArray &F,
                    const FloatArray &internalForcesEBENorm, double &l, referenceLoadInputModeType rlm,
                    int &nite, TimeStep *) override;
    void printState(FILE *outputStream) override;
 
    void initializeFrom(InputRecord &ir) override;
    const char *giveClassName() const override { return "NRSolver"; }
    virtual const char *giveInputRecordName() const { return _IFT_NRSolver_Name; }
 
    void setDomain(Domain *d) override {
        this->domain = d;
        if ( linSolver ) {
            linSolver->setDomain(d);
        }
        if ( linesearchSolver ) {
            linesearchSolver->setDomain(d);
        }
    }
    void reinitialize() override {
        if ( linSolver ) {
            linSolver->reinitialize();
        }
    }
 
    SparseLinearSystemNM *giveLinearSolver() override;
 
protected:
    LineSearchNM *giveLineSearchSolver();

    void initPrescribedEqs();
    void applyConstraintsToStiffness(SparseMtrx &k);
    void applyConstraintsToLoadIncrement(int nite, const SparseMtrx &k, FloatArray &R,
                                         referenceLoadInputModeType rlm, TimeStep *tStep);

    bool checkConvergence(FloatArray &RT, FloatArray &F, FloatArray &rhs, FloatArray &ddX, FloatArray &X,
                          double RRT, const FloatArray &internalForcesEBENorm, int nite, bool &errorOutOfRange);
};
} // end namespace oofem
#endif // nrsolver_h