multiphysics_sys.h

Go to the documentation of this file.

//-----------------------------------------------------------------------bl-
//--------------------------------------------------------------------------
//
// GRINS - General Reacting Incompressible Navier-Stokes
//
// Copyright (C) 2014-2015 Paul T. Bauman, Roy H. Stogner
// Copyright (C) 2010-2013 The PECOS Development Team
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the Version 2.1 GNU Lesser General
// Public License as published by the Free Software Foundation.
//
// 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
//
//-----------------------------------------------------------------------el-


#ifndef GRINS_MULTIPHYSICS_SYS_H
#define GRINS_MULTIPHYSICS_SYS_H

// C++
#include <string>

// GRINS
#include "grins_config.h"
#include "grins/physics.h"

// libMesh
#include "libmesh/fem_system.h"

#ifdef GRINS_HAVE_GRVY
// GRVY timers
#include "grvy.h"
#endif

// libMesh forward declartions
class GetPot;

namespace libMesh
{
  class EquationSystems;
  class DiffContext;

  template <typename Scalar>
  class ParameterMultiPointer;
}

namespace GRINS
{
  // Forward Declarations
  template <typename Scalar>
  class PostProcessedQuantities;


  //TODO: is it F(u) or F(u_{\theta})?
  class MultiphysicsSystem : public libMesh::FEMSystem
  {    
  public:

    MultiphysicsSystem( libMesh::EquationSystems& es,
                        const std::string& name,
                        const unsigned int number );

    ~MultiphysicsSystem();
    
    void attach_physics_list( PhysicsList physics_list );


    virtual void read_input_options( const GetPot& input );

    virtual void init_data();

    void register_postprocessing_vars( const GetPot& input,
                                       PostProcessedQuantities<libMesh::Real>& postprocessing );

    //  named in this call.
    void register_parameter
      ( const std::string & param_name,
        libMesh::ParameterMultiPointer<libMesh::Number>& param_pointer );

    virtual libMesh::AutoPtr<libMesh::DiffContext> build_context();

    virtual void init_context( libMesh::DiffContext &context );

    // residual and jacobian calculations
    // element_*, side_* as *time_derivative, *constraint, *mass_residual

    virtual bool element_time_derivative( bool request_jacobian,
                                          libMesh::DiffContext& context );

    virtual bool side_time_derivative( bool request_jacobian,
                                       libMesh::DiffContext& context );
    
    virtual bool nonlocal_time_derivative( bool request_jacobian,
                                           libMesh::DiffContext& context );
    
    virtual bool element_constraint( bool request_jacobian,
                                     libMesh::DiffContext& context );

    virtual bool side_constraint( bool request_jacobian,
                                  libMesh::DiffContext& context );
    
    virtual bool nonlocal_constraint( bool request_jacobian,
                                      libMesh::DiffContext& context );

    virtual bool mass_residual( bool request_jacobian,
                                libMesh::DiffContext& context );

    virtual bool nonlocal_mass_residual( bool request_jacobian,
                                         libMesh::DiffContext& context );

    bool has_physics( const std::string physics_name ) const;

    std::tr1::shared_ptr<GRINS::Physics> get_physics( const std::string physics_name );

    std::tr1::shared_ptr<GRINS::Physics> get_physics( const std::string physics_name ) const;

    virtual void compute_postprocessed_quantity( unsigned int quantity_index,
                                                 const AssemblyContext& context,
                                                 const libMesh::Point& point,
                                                 libMesh::Real& value );

#ifdef GRINS_USE_GRVY_TIMERS
    void attach_grvy_timer( GRVY::GRVY_Timer_Class* grvy_timer );
#endif    

  private:


    PhysicsList _physics_list;

    bool _use_numerical_jacobians_only;
    
#ifdef GRINS_USE_GRVY_TIMERS
    GRVY::GRVY_Timer_Class* _timer;
#endif

    // Useful typedef for refactoring
    typedef void (GRINS::Physics::*ResFuncType) (bool, AssemblyContext &, CachedValues &);
    typedef void (GRINS::Physics::*CacheFuncType) (const AssemblyContext&, CachedValues &);

    // Refactored residual evaluation implementation
    bool _general_residual( bool request_jacobian,
                            libMesh::DiffContext& context,
                            ResFuncType resfunc,
                            CacheFuncType cachefunc);
  };

  inline
  std::tr1::shared_ptr<GRINS::Physics> MultiphysicsSystem::get_physics( const std::string physics_name ) const
  {
    libmesh_assert(_physics_list.find( physics_name ) != _physics_list.end());

    return _physics_list.find(physics_name)->second;
  }

} //End namespace block

#endif // GRINS_MULTIPHYSICS_SYS_H