function.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 function_h
#define function_h
 
#include "femcmpnn.h"
#include "valuemodetype.h"
#include "intarray.h"
#include "floatarray.h"
#include "gausspoint.h"
 
#include <map>
#include <algorithm>


#define _IFT_Function_initialvalue "initialvalue" 
 
namespace oofem {
class FloatArray;
class IntArray;

class OOFEM_EXPORT FunctionArgument
{
public:
    enum FunctionArgumentType {
        FAT_null,
        FAT_double,
        FAT_FloatArray,
        FAT_int,
        FAT_IntArray,
    };

    FunctionArgumentType type;
 
    double val0;
    FloatArray val1;
    int val2;
    IntArray val3;
 
    FunctionArgument() : type(FAT_null), val0(0), val1(), val2(0), val3() { }
    FunctionArgument(double val) : type(FAT_double), val0(val), val1(), val2(0), val3() { }
    FunctionArgument(FloatArray val) : type(FAT_FloatArray),  val0(0), val1(std::move(val)), val2(0), val3() { }
    FunctionArgument(int val) : type(FAT_int),  val0(0), val1(), val2(val), val3() { }
    FunctionArgument(IntArray val) : type(FAT_IntArray),  val0(0), val1(), val2(0), val3(std::move(val)) { }
};

class OOFEM_EXPORT Function : public FEMComponent
{
public:
    Domain *funcDomain;
    int parameterType;

    Function(int n, Domain * d);
    virtual ~Function() { }

    virtual double evaluate(TimeStep *tStep, ValueModeType mode);

    virtual void evaluate(FloatArray &answer, const std :: map< std :: string, FunctionArgument > &valDict, GaussPoint *gp=nullptr, double param=0.);
    virtual double evaluate(const std :: map< std :: string, FunctionArgument > &valDict);

    virtual double evaluateAtTime(double t);
    virtual double evaluateVelocityAtTime(double t) = 0;
    virtual double evaluateAccelerationAtTime(double t) = 0;
 
    double giveFunctionParameter(int paramID);
    void saveContext(DataStream &stream, ContextMode mode) override;
    void restoreContext(DataStream &stream, ContextMode mode) override;
};
} // end namespace oofem
#endif // function_h