transient_solver_base.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__transient_solver_base__
#define __mast__transient_solver_base__

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

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


namespace MAST {
    
    // Forward declerations
    class TransientAssemblyElemOperations;
    class ElementBase;
    class NonlinearSystem;
    
    
    class TransientSolverBase:
    public MAST::NonlinearImplicitAssemblyElemOperations {
    public:
        TransientSolverBase(unsigned int o,
                            unsigned int n);
        
        virtual ~TransientSolverBase();

        
        virtual void
        set_assembly(MAST::AssemblyBase &assembly);
        
        
        virtual void clear_assembly();

        virtual void set_elem_operation_object(MAST::TransientAssemblyElemOperations& elem_ops);

        virtual MAST::TransientAssemblyElemOperations&
        get_elem_operation_object();
        
        
        virtual void clear_elem_operation_object();
        
        Real dt;

        
        libMesh::NumericVector<Real>&
        solution(unsigned int prev_iter = 0) const;

        libMesh::NumericVector<Real>&
        solution_sensitivity(unsigned int prev_iter = 0) const;

        libMesh::NumericVector<Real>&
        velocity(unsigned int prev_iter = 0) const;

        
        libMesh::NumericVector<Real>&
        velocity_sensitivity(unsigned int prev_iter = 0) const;

        
        libMesh::NumericVector<Real>&
        acceleration(unsigned int prev_iter = 0) const;
        
        libMesh::NumericVector<Real>&
        acceleration_sensitivity(unsigned int prev_iter = 0) const;

        
        virtual void update_velocity(libMesh::NumericVector<Real>& vel,
                                     const libMesh::NumericVector<Real>& sol) = 0;
        
        virtual void update_acceleration(libMesh::NumericVector<Real>& acc,
                                         const libMesh::NumericVector<Real>& sol) = 0;

        virtual void update_sensitivity_velocity(libMesh::NumericVector<Real>& vel,
                                                 const libMesh::NumericVector<Real>& sol) = 0;
        
        virtual void update_sensitivity_acceleration(libMesh::NumericVector<Real>& acc,
                                                     const libMesh::NumericVector<Real>& sol) = 0;

        
        virtual void
        update_delta_velocity(libMesh::NumericVector<Real>& vel,
                              const libMesh::NumericVector<Real>& sol) = 0;
        
        virtual void
        update_delta_acceleration(libMesh::NumericVector<Real>& acc,
                                  const libMesh::NumericVector<Real>& sol) = 0;

        virtual void solve(MAST::AssemblyBase& assembly);
        
        virtual void sensitivity_solve(MAST::AssemblyBase& assembly,
                                       const MAST::FunctionBase& f);

        
        void solve_highest_derivative_and_advance_time_step(MAST::AssemblyBase& assembly);
        
        void
        solve_highest_derivative_and_advance_time_step_with_sensitivity(MAST::AssemblyBase& assembly,
                                                                        const MAST::FunctionBase& f);


        
        virtual void advance_time_step();
        
        virtual void advance_time_step_with_sensitivity();

        
        virtual void
        build_local_quantities(const libMesh::NumericVector<Real>& current_sol,
                               std::vector<libMesh::NumericVector<Real>*>& qtys);

        virtual void
        build_sensitivity_local_quantities(unsigned int prev_iter,
                                           std::vector<libMesh::NumericVector<Real>*>& qtys);

        virtual void
        build_perturbed_local_quantities
        (const libMesh::NumericVector<Real>& current_sol,
         std::vector<libMesh::NumericVector<Real>*>& qtys);


        virtual void
        set_element_data(const std::vector<libMesh::dof_id_type>& dof_indices,
                         const std::vector<libMesh::NumericVector<Real>*>& sols) = 0;
        
        
        virtual void
        extract_element_sensitivity_data(const std::vector<libMesh::dof_id_type>& dof_indices,
                                         const std::vector<libMesh::NumericVector<Real>*>& sols,
                                         std::vector<RealVectorX>& local_sols) = 0;

        virtual void
        elem_sensitivity_contribution_previous_timestep(const std::vector<RealVectorX>& prev_sols,
                                                        RealVectorX& vec) = 0;
        
        virtual void
        set_element_perturbed_data
        (const std::vector<libMesh::dof_id_type>& dof_indices,
         const std::vector<libMesh::NumericVector<Real>*>& sols) = 0;

        
        virtual void
        set_elem_data(unsigned int dim,
                      const libMesh::Elem& ref_elem,
                      MAST::GeomElem& elem) const;

        virtual void
        init(const MAST::GeomElem& elem);

        virtual void clear_elem();
                
    protected:
        
        bool  _first_step, _first_sensitivity_step;
        
        
        const unsigned int _ode_order;
        
        const unsigned int _n_iters_to_store;
        
        
        MAST::TransientAssemblyElemOperations* _assembly_ops;
                
        bool   _if_highest_derivative_solution;

    };

}


#endif // __mast__transient_solver_base__