linesearch.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 linesearch_h
#define linesearch_h
 
#include "nummet.h"
#include "convergedreason.h"
#include "floatarray.h"


#define _IFT_LineSearchNM_lsearchtol "lsearchtol"
#define _IFT_LineSearchNM_lsearchamp "lsearchamp"
#define _IFT_LineSearchNM_lsearchmaxeta "lsearchmaxeta"
 
namespace oofem {
class EngngModel;
class SparseMtrx;
class FloatArray;
class TimeStep;

class OOFEM_EXPORT LineSearchNM : public NumericalMethod
{
public:
    enum LS_status { ls_ok, ls_failed };
 
    int max_iter;
    double ls_tolerance;
    double amplifFactor;
    double maxEta, minEta;
    FloatArray eta;
    FloatArray prod;
 
public:
    LineSearchNM(Domain * d, EngngModel * m);

    ConvergedReason solve(FloatArray &r, FloatArray &dr, FloatArray &F, FloatArray &R, FloatArray *R0,
                    IntArray &eqnmask, double lambda, double &etaValue, LS_status &status, TimeStep *tStep);
 
    void initializeFrom(InputRecord &ir) override;
    const char *giveClassName() const { return "LineSearchNM"; }
 
protected:
    void search(int istep, FloatArray &prod, FloatArray &eta, double amp, double maxeta, double mineta, int &status);
};
} // end namespace oofem
#endif // linesearch_h