parameter.h

Go to the documentation of this file.

/*
 * MAST: Multidisciplinary-design Adaptation and Sensitivity Toolkit
 * Copyright (C) 2013-2019  Manav Bhatia
 *
 * 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 library 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 __mast__parameter__
#define __mast__parameter__


// MAST includes
#include "base/function_base.h"


namespace MAST {
    
    class Parameter:
    public MAST::FunctionBase {

    public:
        
        Parameter(const std::string& nm,
                  const Real& val):
        MAST::FunctionBase(nm, false),
        _val(new Real)
        { *_val = val;}

        
        Parameter(const MAST::Parameter& f):
        MAST::FunctionBase(f),
        _val(f._val)
        { }
        

        virtual ~Parameter() {

            delete _val;
        }
        
        
        Real& operator() () {
            return *_val;
        }

        
        Real operator() () const {
            return *_val;
        }
        
        
        Real* ptr()
        {   return _val; }
        
        
        
        virtual bool depends_on(const MAST::FunctionBase& f) const {
            if (&f == this)
                return true;
            else
                return false;
        }
        
        
        
        void operator =(const Real& val)
        {   *_val = val; }
        
        
    protected:
        
        Real* _val;
    };
}

#endif // __mast__parameter__