continuation_solver_base.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__continuation_solver_base_h__
#define __mast__continuation_solver_base_h__

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

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


namespace MAST {

    // Forward declerations
    class AssemblyElemOperations;
    class AssemblyBase;
    class Parameter;
    
    class ContinuationSolverBase {
        
    public:
        
        ContinuationSolverBase();
        
        
        virtual ~ContinuationSolverBase();
        
        void
        set_assembly_and_load_parameter(MAST::AssemblyElemOperations&   elem_ops,
                                        MAST::AssemblyBase&             assembly,
                                        MAST::Parameter&                p);
        
        void clear_assembly_and_load_parameters();
        
        virtual void initialize(Real dp) =0;
        
        virtual void solve();
        
        unsigned int
        max_it;
        
        Real
        abs_tol;

        Real
        rel_tol;
    
        Real
        arc_length;
        
        Real
        min_step;
        
        Real
        max_step;
        
        Real
        step_size_change_exponent;

        unsigned int
        step_desired_iters;
        
        bool schur_factorization;
        
    protected:

        virtual void
        _solve_NR_iterate(libMesh::NumericVector<Real>       &X,
                          MAST::Parameter                    &p) = 0;

        void
        _solve(const libMesh::NumericVector<Real>  &X,
               const MAST::Parameter               &p,
               libMesh::NumericVector<Real>        &f,
               bool                                update_f,
               libMesh::NumericVector<Real>        &dfdp,
               bool                                update_dfdp,
               const libMesh::NumericVector<Real>  &dgdX,
               const Real                          dgdp,
               const Real                          g,
               libMesh::NumericVector<Real>        &dX,
               Real                                &dp);


        void
        _solve_schur_factorization(const libMesh::NumericVector<Real>  &X,
                                   const MAST::Parameter               &p,
                                   libMesh::SparseMatrix<Real>         &jac,
                                   bool                                update_jac,
                                   libMesh::NumericVector<Real>        &f,
                                   bool                                update_f,
                                   libMesh::NumericVector<Real>        &dfdp,
                                   bool                                update_dfdp,
                                   libMesh::NumericVector<Real>        &dXdp,
                                   bool                                update_dXdp,
                                   const libMesh::NumericVector<Real>  &dgdX,
                                   const Real                          dgdp,
                                   const Real                          g,
                                   libMesh::NumericVector<Real>        &dX,
                                   Real                                &dp);

        Real _res_norm(const libMesh::NumericVector<Real>                  &X,
                       const MAST::Parameter                               &p);
        
        virtual Real
        _g(const libMesh::NumericVector<Real> &X,
           const MAST::Parameter              &p) = 0;

        virtual void _save_iteration_data() = 0;

        virtual void _reset_iterations() = 0;
        
        bool                           _initialized;
        
        MAST::AssemblyElemOperations   *_elem_ops;
        MAST::AssemblyBase             *_assembly;
        MAST::Parameter                *_p;

        Real
        _p0,
        _X_scale,
        _p_scale;
        
        std::unique_ptr<libMesh::NumericVector<Real>>
        _X0;
    };
}


#endif // __mast__continuation_solver_base_h__