calmls.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 calmls_h
#define calmls_h
 
#include <set>
#include <vector>
#include <memory>
 
#include "sparselinsystemnm.h"
#include "sparsenonlinsystemnm.h"
#include "convergedreason.h"
#include "floatarray.h"
#include "intarray.h"
#include "dofiditem.h"


#define _IFT_CylindricalALM_Name "calm"
#define _IFT_CylindricalALM_psi "psi"
#define _IFT_CylindricalALM_maxiter "maxiter"
#define _IFT_CylindricalALM_maxrestarts "maxrestarts"
#define _IFT_CylindricalALM_minsteplength "minsteplength"
#define _IFT_CylindricalALM_steplength "steplength"
#define _IFT_CylindricalALM_initialsteplength "initialsteplength"
#define _IFT_CylindricalALM_forcedinitialsteplength "forcedinitialsteplength"
#define _IFT_CylindricalALM_reqiterations "reqiterations"
#define _IFT_CylindricalALM_miniterations "miniter"
#define _IFT_CylindricalALM_manrmsteps "manrmsteps"
#define _IFT_CylindricalALM_hpcmode "hpcmode"
#define _IFT_CylindricalALM_hpc "hpc"
#define _IFT_CylindricalALM_hpcw "hpcw"
#define _IFT_CylindricalALM_lstype "lstype"
#define _IFT_CylindricalALM_linesearch "linesearch"
#define _IFT_CylindricalALM_lsearchtol "lsearchtol"
#define _IFT_CylindricalALM_lsearchamp "lsearchamp"
#define _IFT_CylindricalALM_lsearchmaxeta "lsearchmaxeta"
#define _IFT_CylindricalALM_nccdg "nccdg"
#define _IFT_CylindricalALM_ccdg "ccdg"
#define _IFT_CylindricalALM_rtolv "rtolv"
#define _IFT_CylindricalALM_rtolf "rtolf"
#define _IFT_CylindricalALM_rtold "rtold"
#define _IFT_CylindricalALM_rootselectiontype "rootselectiontype"
 
 
namespace oofem {
class Domain;
class EngngModel;
class ParallelContext;
 
#define calm_SMALL_NUM 1.e-20
#define calm_SMALL_ERROR_NUM 1.e-6

class OOFEM_EXPORT CylindricalALM : public SparseNonLinearSystemNM
{
protected:
    enum calm_ControlType {
        calm_hpc_off = 0, 
        calm_hpc_on, 
        calml_hpc, 
    };

    enum calm_NR_ModeType {
        calm_modifiedNRM, 
        calm_fullNRM, 
        calm_accelNRM, 
    };
 
    typedef std :: set< DofIDItem > __DofIDSet;
 
    int nsmax;
    int maxRestarts;
    double Psi;
    double deltaL, minStepLength, maxStepLength;
    int solved, numberOfRequiredIterations;
    calm_NR_ModeType calm_NR_Mode, calm_NR_OldMode;
    int calm_NR_ModeTick;
    int calm_MANRMSteps;

    int minIterations;

    int calm_hpc_init;
    calm_ControlType calm_Control;
    FloatArray calm_HPCWeights;
    IntArray calm_HPCIndirectDofMask;
    IntArray calm_HPCDmanDofSrcArray;
    FloatArray calm_HPCDmanWeightSrcArray;

    std :: unique_ptr< SparseLinearSystemNM > linSolver;
    LinSystSolverType solverType;

    int lsFlag;
    double ls_tolerance;
    double amplifFactor;
    double maxEta, minEta;
 
    // Support for evaluation of error norms for user defined dof-groups.
    int nccdg;
    std :: vector< __DofIDSet >ccDofGroups;
    FloatArray rtolf;
    FloatArray rtold;
    ParallelContext *parallel_context;

    enum RootSelectionType {
      RST_Cos=0,
      RST_Dot=1,
    };

    RootSelectionType rootselectiontype;
    FloatArray old_dX;
 
public:
    CylindricalALM(Domain * d, EngngModel * m);
    virtual ~CylindricalALM();
 
    // Overloaded methods:
    ConvergedReason solve(SparseMtrx &K, FloatArray &R, FloatArray *R0,
                    FloatArray &X, FloatArray &dX, FloatArray &F,
                    const FloatArray &internalForcesEBENorm, double &ReachedLambda, referenceLoadInputModeType rlm,
                    int &nite, TimeStep *) override;
    double giveCurrentStepLength() override { return deltaL; }
    void setStepLength(double s) override { deltaL = s; }
    void initializeFrom(InputRecord &ir) override;
    bool referenceLoad() const override { return true; }
    void saveContext(DataStream &stream, ContextMode mode) override;
    void restoreContext(DataStream &stream, ContextMode mode) override;
    void setDomain(Domain *d) override {
        this->domain = d;
        if ( linSolver ) {
            linSolver->setDomain(d);
        }
    }
    void reinitialize() override {
        calm_hpc_init = 1;
        if ( linSolver ) {
            linSolver->reinitialize();
        }
    }
    const char *giveClassName() const override { return "CylindricalALM"; }
    const char *giveInputRecordName() const { return _IFT_CylindricalALM_Name; }
 
    SparseLinearSystemNM *giveLinearSolver() override;
 
protected:
    void convertHPCMap();

    int computeDeltaLambda(double &deltaLambda, const FloatArray &dX, const FloatArray &deltaXt,
                           const FloatArray &deltaX_, const FloatArray &R, double RR, double eta,
                           double deltaL, double DeltaLambda0, int neq);
 
    void search(int istep, FloatArray &prod, FloatArray &eta, double amp,
                double maxeta, double mineta, int &status);

    bool checkConvergence(const FloatArray &R, const FloatArray *R0, const FloatArray &F,
                          const FloatArray &X, const FloatArray &ddX,
                          double Lambda, double RR0, double RR, double drProduct,
                          const FloatArray &internalForcesEBENorm, int nite, bool &errorOutOfRange);

    void do_lineSearch(FloatArray &X, const FloatArray &XInitial, const FloatArray &deltaX_, const FloatArray &deltaXt,
                       const FloatArray &dXm1, FloatArray &dX, FloatArray &ddX,
                       const FloatArray &R, const FloatArray *R0, const FloatArray &F,
                       double &DeltaLambda, double &DeltaLambdam1, double &deltaLambda,
                       double &Lambda, double &ReachedLambda, double RR, double &drProduct, TimeStep *tStep);
};
} // end namespace oofem
#endif // calmls_h