scalarfunction.h

Go to the documentation of this file.

/*
 *
 *                 #####    #####   ######  ######  ###   ###
 *               ##   ##  ##   ##  ##      ##      ## ### ##
 *              ##   ##  ##   ##  ####    ####    ##  #  ##
 *             ##   ##  ##   ##  ##      ##      ##     ##
 *            ##   ##  ##   ##  ##      ##      ##     ##
 *            #####    #####   ##      ######  ##     ##
 *
 *
 *             OOFEM : Object Oriented Finite Element Code
 *
 *               Copyright (C) 1993 - 2013   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 scalarfunction_h
#define scalarfunction_h

#include "parser.h"
#include "error.h"
#include "gausspoint.h"

#include <string>
#include <map>

namespace oofem {
class FunctionArgument;
class Domain;
class FloatArray;

class ScalarFunction
{
    double dValue;
    std :: string eValue;
    int fReference;

    enum { DV_Undefined, DV_ValueType, DV_SimpleExpressionType, DV_FunctionReferenceType } dvType;

public:
    ScalarFunction();
    ScalarFunction(double val);
    ScalarFunction(std :: string & val);
    ScalarFunction(int val);

    ~ScalarFunction();
    void setValue(double val);

    void setSimpleExpression(std :: string &val);

    void setReference(int val);

    double eval(const std :: map< std :: string, FunctionArgument >valDict, Domain *d, GaussPoint *gp=NULL, double param=0.) const;

    double eval(double time, Domain *d) const;

    /*
     * Evaluates the receiver (convenience function that directly takes just the time and coordinates as parameters).
     * @param time Time to evaluate for.
     * @param coords Coordinates to evaluate for.
     * @param d domain managing external functions
     */
    //double eval(double time, const FloatArray &coords, Domain *d) const;
    
    bool isDefined() const;

    friend std :: ostream &operator << ( std :: ostream & out, const ScalarFunction & s );
};
} // end namespace OOFEM

#endif // scalarfunction_h