multiphysics_nonlinear_solver.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__multiphysics_nonlinear_solver_base_h__
#define __mast__multiphysics_nonlinear_solver_base_h__

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

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

// libMesh includes
#include "libmesh/parallel_object.h"
#include "libmesh/numeric_vector.h"

// PETSc includes
#include <petscmat.h>
#include <petscsnes.h>


namespace MAST {

    // Forward declerations
    class TransientAssembly;
    
    
    class MultiphysicsNonlinearSolverBase:
    public libMesh::ParallelObject {
        
    public:
        
        MultiphysicsNonlinearSolverBase(const libMesh::Parallel::Communicator& comm_in,
                                        const std::string& nm,
                                        unsigned int n);
        

        virtual ~MultiphysicsNonlinearSolverBase();

        
        const std::string name() const {
            
            return _name;
        }
        
        
        unsigned int n_disciplines() const {
            
            return _n_disciplines;
        }
        
        
        
        void set_system_assembly(unsigned int i,
                                 MAST::TransientAssembly& assembly);


        
        MAST::TransientAssembly& get_system_assembly(unsigned int i);

        
        
        std::vector<IS>& index_sets() {
            
            return _is;
        }
        
        
        Mat mat() {
            
            return _mat;
        }
        
        void solve();
        

        class PreResidualUpdate {
            
        public:
            
            virtual ~PreResidualUpdate() {}
            
            virtual void
            update_at_solution(std::vector<libMesh::NumericVector<Real>*>&  sol_vecs) = 0;
            
            virtual void
            update_at_perturbed_solution
            (std::vector<libMesh::NumericVector<Real>*>&   sol_vecs,
             std::vector<libMesh::NumericVector<Real>*>&  dsol_vecs) = 0;
            
        };

        

        void
        set_pre_residual_update_object
        (MAST::MultiphysicsNonlinearSolverBase::PreResidualUpdate& update) {
            
            _update = &update;
        }

        
        MAST::MultiphysicsNonlinearSolverBase::PreResidualUpdate*
        get_pre_residual_update_object() {
            
            return _update;
        }

        
        void verify_gateaux_derivatives(SNES snes);
        
        
    protected:
        

        const std::string  _name;
        
        const unsigned int _n_disciplines;

        MAST::MultiphysicsNonlinearSolverBase::PreResidualUpdate  *_update;
        
        std::vector<MAST::TransientAssembly*>  _discipline_assembly;

        std::vector<IS>  _is;
        std::vector<Mat> _sub_mats; // row-major ordering
        unsigned int     _n_dofs;

        Mat              _mat;
        Vec              _sol, _res;

    };
}



#endif // __mast__multiphysics_nonlinear_solver_base_h__