surface_integrated_pressure_output.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__surface_integrated_pressure_output__
#define __mast__surface_integrated_pressure_output__

// C++ includes
#include <map>
#include <vector>

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


namespace MAST {
    
    
    // Forward declerations
    class FunctionBase;
    
    
    class SurfaceIntegratedPressureOutput:
    public MAST::OutputAssemblyElemOperations {
        
    public:
        
        enum OutputMode {
            L2_NORM,     //  L2 norm of the lift
            UNIT_VEC     //  dot product of the lift with a user provided unit vector
        };
        
        
        SurfaceIntegratedPressureOutput(MAST::SurfaceIntegratedPressureOutput::OutputMode o,
                                        const RealVectorX& n_vec = RealVectorX::Zero(3,1));
        
        virtual ~SurfaceIntegratedPressureOutput();
        
        
        void clear();
        
        void set_output_mode(MAST::SurfaceIntegratedPressureOutput::OutputMode o,
                             const RealVectorX* n_vec = nullptr);
        

        void set_load(const RealVectorX& v) {
            
            libmesh_assert_equal_to(v.size(), 3);
            _load = v;
        }
        

        Real value() const;

        
        void set_load_sensitivity(const MAST::FunctionBase& f,
                                  const RealVectorX& v) {
            
            libmesh_assert_equal_to(v.size(), 3);
            libmesh_assert(_load_sensitivity.find(&f) == _load_sensitivity.end());
            
            _load_sensitivity[&f] = v;
        }

        
        Real sensitivity(const MAST::FunctionBase& f) const;

        
        void set_load_derivative(const RealMatrixX& m) {
            
            libmesh_assert_equal_to(m.rows(), 3);
            
            _dload_dX = m;
        }

        RealVectorX derivative() const;
        
        
    protected:

        MAST::SurfaceIntegratedPressureOutput::OutputMode _mode;
        
        
        RealVectorX _n_vec;
        
        
        RealVectorX  _load;
        
        std::map<const MAST::FunctionBase*, RealVectorX> _load_sensitivity;
        
        
        RealMatrixX   _dload_dX;
    };
}

#endif // __mast__surface_integrated_pressure_output__