level_set_nonlinear_implicit_assembly.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__level_set_nonlinear_implicit_assembly_h__
#define __mast__level_set_nonlinear_implicit_assembly_h__

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


namespace MAST {
    
    // Forward declerations
    template <typename ValType> class FieldFunction;
    class LevelSetIntersection;
    class LevelSetInterfaceDofHandler;
    class LevelSetVoidSolution;
    class FilterBase;
    
    
    class LevelSetNonlinearImplicitAssembly:
    public MAST::NonlinearImplicitAssembly {
    public:
        
        
        LevelSetNonlinearImplicitAssembly(bool enable_dof_handler);
        
        
        virtual ~LevelSetNonlinearImplicitAssembly();

        void set_evaluate_output_on_negative_phi(bool f);

        
        bool if_use_dof_handler() const;
        
        
        virtual void
        set_level_set_function(MAST::FieldFunction<Real>& level_set,
                               const MAST::FilterBase& filter);

        
        virtual void
        set_indicator_function(MAST::FieldFunction<RealVectorX>& indicator);
        
        virtual void
        clear_level_set_function();

        virtual void
        set_level_set_velocity_function(MAST::FieldFunction<RealVectorX>& velocity);
        
        
        virtual void
        clear_level_set_velocity_function();

        
        MAST::LevelSetIntersection& get_intersection();

        
        MAST::LevelSetInterfaceDofHandler& get_dof_handler();

        
        virtual void
        residual_and_jacobian (const libMesh::NumericVector<Real>& X,
                               libMesh::NumericVector<Real>* R,
                               libMesh::SparseMatrix<Real>*  J,
                               libMesh::NonlinearImplicitSystem& S);

        
        virtual bool
        sensitivity_assemble (const MAST::FunctionBase& f,
                              libMesh::NumericVector<Real>& sensitivity_rhs);
        
        
        virtual void
        calculate_output_derivative(const libMesh::NumericVector<Real>& X,
                                    MAST::OutputAssemblyElemOperations& output,
                                    libMesh::NumericVector<Real>& dq_dX);
        
//#define MAST_ENABLE_PLPLOT 1
#if MAST_ENABLE_PLPLOT == 1
        void plot_sub_elems(bool plot_reference_elem,
                            bool plot_low_phi_elem,
                            bool plot_high_phi_elem);
#endif
        
        
        virtual void
        calculate_output(const libMesh::NumericVector<Real>& X,
                         MAST::OutputAssemblyElemOperations& output);
        
        
        
        virtual void
        calculate_output_direct_sensitivity(const libMesh::NumericVector<Real>& X,
                                            const libMesh::NumericVector<Real>* dXdp,
                                            const MAST::FunctionBase& p,
                                            MAST::OutputAssemblyElemOperations& output);
        
        
        /*virtual Real
        calculate_output_adjoint_sensitivity(const libMesh::NumericVector<Real>& X,
                                             const libMesh::NumericVector<Real>& dq_dX,
                                             const MAST::FunctionBase& p,
                                             MAST::AssemblyElemOperations&       elem_ops,
                                             MAST::OutputAssemblyElemOperations& output,
                                             const bool include_partial_sens = true);
         */
        
    protected:

        /*Real
        _adjoint_sensitivity_dot_product (const MAST::FunctionBase& f,
                                          const libMesh::NumericVector<Real>& X,
                                          const libMesh::NumericVector<Real>& dq_dX);
        */
        
        bool                                  _enable_dof_handler;
        
        bool                                  _evaluate_output_on_negative_phi;

        MAST::FieldFunction<Real>            *_level_set;

        MAST::FieldFunction<RealVectorX>     *_indicator;

        MAST::LevelSetIntersection           *_intersection;

        MAST::LevelSetInterfaceDofHandler    *_dof_handler;
        
        MAST::LevelSetVoidSolution           *_void_solution_monitor;

        MAST::FieldFunction<RealVectorX>     *_velocity;
        
        const MAST::FilterBase               *_filter;

    };
}


#endif //__mast__level_set_nonlinear_implicit_assembly_h__