nonlinear_implicit_assembly.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__nonlinear_implicit_assembly__
#define __mast__nonlinear_implicit_assembly__

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

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


namespace MAST {
    
    // Forward declerations
    class NonlinearImplicitAssemblyElemOperations;
    
    
    class NonlinearImplicitAssembly:
    public MAST::AssemblyBase {
    public:
        
        
        class PostAssemblyOperation{
            
        public:
            PostAssemblyOperation() {}
            virtual ~PostAssemblyOperation() {}
            virtual void post_assembly(const libMesh::NumericVector<Real>& X,
                                       libMesh::NumericVector<Real>* R,
                                       libMesh::SparseMatrix<Real>*  J,
                                       libMesh::NonlinearImplicitSystem& S) = 0;
        };

        NonlinearImplicitAssembly();
        
        
        virtual ~NonlinearImplicitAssembly();
        
        
        
        Real res_l2_norm() const { return _res_l2_norm; }
        
        Real first_iter_res_l2_norm() const { return _first_iter_res_l2_norm; }

        void reset_residual_norm_history() {
            _res_l2_norm = 0.;
            _first_iter_res_l2_norm = -1.;
        }

        void
        set_post_assembly_operation(MAST::NonlinearImplicitAssembly::PostAssemblyOperation& post);
        
        virtual void
        residual_and_jacobian (const libMesh::NumericVector<Real>& X,
                               libMesh::NumericVector<Real>* R,
                               libMesh::SparseMatrix<Real>*  J,
                               libMesh::NonlinearImplicitSystem& S);
        
        
        virtual void
        linearized_jacobian_solution_product(const libMesh::NumericVector<Real>& X,
                                             const libMesh::NumericVector<Real>& dX,
                                             libMesh::NumericVector<Real>& JdX,
                                             libMesh::NonlinearImplicitSystem& S);


        virtual void
        second_derivative_dot_solution_assembly(const libMesh::NumericVector<Real>& X,
                                                bool if_localize_sol,
                                                const libMesh::NumericVector<Real>& dX,
                                                bool if_localize_sol_sens,
                                                libMesh::SparseMatrix<Real>& d_JdX_dX,
                                                libMesh::NonlinearImplicitSystem& S);

        
        virtual bool
        sensitivity_assemble (const libMesh::NumericVector<Real>& X,
                              bool if_localize_sol,
                              const MAST::FunctionBase& f,
                              libMesh::NumericVector<Real>& sensitivity_rhs,
                              bool close_vector = true);
        
    protected:
        

        
        MAST::NonlinearImplicitAssembly::PostAssemblyOperation* _post_assembly;

        Real _res_l2_norm, _first_iter_res_l2_norm;
        
    };
}


#endif //__mast__nonlinear_implicit_assembly__