output_assembly_elem_operations.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__output_function_base__
#define __mast__output_function_base__

// C++ includes
#include <set>
#include <memory>

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

// libMesh includes
#include "libmesh/elem.h"



namespace MAST {
    
    // Forward declerations
    class FunctionBase;
    class ElementBase;
    class GeomElem;
    class LevelSetIntersection;
    template <typename ValType> class FieldFunction;

    class OutputAssemblyElemOperations:
    public MAST::AssemblyElemOperations {
        
    public:
        
        OutputAssemblyElemOperations();

        virtual ~OutputAssemblyElemOperations();
       
        
        virtual void zero_for_analysis() = 0;

        
        virtual void zero_for_sensitivity() = 0;

        virtual Real output_for_elem() = 0;

        virtual Real output_total() = 0;

        virtual Real output_sensitivity_for_elem(const MAST::FunctionBase& p) = 0;

        virtual Real output_sensitivity_total(const MAST::FunctionBase& p) = 0;


        virtual void output_derivative_for_elem(RealVectorX& dq_dX) = 0;

        
        virtual void evaluate() = 0;

        virtual void evaluate_sensitivity(const MAST::FunctionBase& f) = 0;

        virtual void evaluate_shape_sensitivity(const MAST::FunctionBase& f) = 0;

        virtual void
        evaluate_topology_sensitivity(const MAST::FunctionBase& f) = 0;

        virtual void
        evaluate_topology_sensitivity(const MAST::FunctionBase& f,
                                      const MAST::FieldFunction<RealVectorX>& vel) = 0;

        void set_participating_subdomains(const std::set<libMesh::subdomain_id_type>& sids);

        void set_participating_elements(const std::set<const libMesh::Elem*>& elems);

        
        void set_participating_elements_to_all();

        void set_participating_boundaries(const std::set<libMesh::boundary_id_type>& bids);

        const std::set<const libMesh::Elem*>&
        get_participating_elements() const;
        

        const std::set<libMesh::subdomain_id_type>&
        get_participating_subdomains();
        
        
        const std::set<libMesh::boundary_id_type>&
        get_participating_boundaries();

        
        virtual bool if_evaluate_for_element(const MAST::GeomElem& elem) const;

        
        virtual bool if_evaluate_for_boundary(const MAST::GeomElem& elem,
                                              const unsigned int s) const;

        
    protected:
        
        bool _if_evaluate_on_all_elems;
        
        std::set<const libMesh::Elem*> _elem_subset;

        
        std::set<libMesh::subdomain_id_type> _sub_domain_ids;

        
        std::set<libMesh::boundary_id_type> _bids;

    };
}

#endif // __mast__output_function_base__