function_base.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__function_base__
#define __mast__function_base__

// C++ includes
#include <set>


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


namespace MAST
{
    
    
    class FunctionBase {
    public:
        
        FunctionBase(const std::string& nm ,
                     const bool is_field_func);

        
        FunctionBase(const MAST::FunctionBase& f);

        
        virtual ~FunctionBase() { }
        
        
        const std::string& name() const {
            return _name;
        }
        
        
        virtual bool depends_on(const MAST::FunctionBase& f) const {
            if (_functions.count(&f))   // this function is the same
                return true;
            
            // check with all functions if they are dependent
            std::set<const MAST::FunctionBase*>::const_iterator
            it = _functions.begin(), end = _functions.end();
            
            for ( ; it != end; it++)
                if ((*it)->depends_on(f))
                    return true;
            
            // if it gets here, then there is no dependency
            return false;
        }
        
        
        virtual bool is_shape_parameter() const {return _is_shape_parameter; }
        virtual void set_as_shape_parameter(bool f) {_is_shape_parameter = f;}


        virtual bool is_topology_parameter() const {return _is_topology_parameter;}
        virtual void set_as_topology_parameter(bool f) {_is_topology_parameter = f;}
        
    protected:
        
        std::string _name;
        
        bool _is_field_func;

        bool _is_shape_parameter;
        bool _is_topology_parameter;
        
        std::set<const MAST::FunctionBase*> _functions;
    };
    
}

#endif // __mast__function_base__