mesh_field_function.h

Go to the documentation of this file.

/*
 * MAST: Multidisciplinary-design Adaptation and Sensitivity Toolkit
 * Copyright (C) 2013-2020  Manav Bhatia and MAST authors
 *
 * 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__mesh_field_function__
#define __mast__mesh_field_function__

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


// libMesh includes
#include "libmesh/numeric_vector.h"
#include "libmesh/mesh_function.h"
#include "libmesh/system.h"



namespace MAST {

    // Forward declerations
    class SystemInitialization;
    
    
    class MeshFieldFunction:
    public MAST::FieldFunction<RealVectorX> {
        
    public:
        MeshFieldFunction(MAST::SystemInitialization& sys,
                          const std::string& nm,
                          libMesh::ParallelType p_type);

        
        MeshFieldFunction(libMesh::System& sys,
                          const std::string& nm,
                          libMesh::ParallelType p_type);

        
        virtual ~MeshFieldFunction();

       
        virtual void operator() (const libMesh::Point& p,
                                 const Real t,
                                 RealVectorX& v) const;
        
        virtual void gradient(const libMesh::Point& p,
                              const Real t,
                              RealMatrixX& g) const;

        virtual void perturbation (const libMesh::Point& p,
                                   const Real t,
                                   RealVectorX& v) const;
        

        virtual void perturbation_gradient (const libMesh::Point& p,
                                            const Real t,
                                            RealMatrixX& v) const;


        virtual void derivative (const MAST::FunctionBase& f,
                                 const libMesh::Point& p,
                                 const Real t,
                                 RealVectorX& v) const;

        virtual void derivative_gradient (const MAST::FunctionBase& f,
                                          const libMesh::Point& p,
                                          const Real t,
                                          RealMatrixX& v) const;

        void init(const libMesh::NumericVector<Real>& sol, bool reuse_vector);

        
        void init_sens(const MAST::FunctionBase& f,
                       const libMesh::NumericVector<Real>& dsol,
                       bool reuse_vector);

        
        libMesh::MeshFunction& get_function() {
            
            libmesh_assert(_function);
            return *_function->_func;
        }

        libMesh::MeshFunction& get_perturbed_function() {
            
            libmesh_assert(_perturbed_function);
            return *_perturbed_function->_func;
        }

        
        virtual void set_element_quadrature_point_solution(RealVectorX& sol);

        
        virtual void clear_element_quadrature_point_solution();

        
        void clear();

    protected:
        
        struct SolFunc {
            SolFunc():
            _sol        (nullptr),
            _cloned_sol (nullptr),
            _func       (nullptr) {}
            ~SolFunc() {
                if (_cloned_sol) delete _cloned_sol;
                delete _func;
            }
            
            bool _reuse_sol;
            const libMesh::NumericVector<Real>* _sol;
            libMesh::NumericVector<Real>* _cloned_sol;
            libMesh::MeshFunction* _func;
        };
        
        
        void _init_sol_func(bool reuse_sol,
                            const libMesh::NumericVector<Real>& sol,
                            MAST::MeshFieldFunction::SolFunc& sol_func);
        
        bool _use_qp_sol;
        
        libMesh::ParallelType _p_type;
        
        RealVectorX _qp_sol;
        
        libMesh::System* _sys;
        
        SolFunc*  _function;

        
        SolFunc*  _perturbed_function;

        std::map<const MAST::FunctionBase*, MAST::MeshFieldFunction::SolFunc*> _function_sens;
    };
}

#endif // __mast__mesh_field_function__