multi_domain.h

Go to the documentation of this file.

// LIC// ====================================================================
// LIC// This file forms part of oomph-lib, the object-oriented,
// LIC// multi-physics finite-element library, available
// LIC// at http://www.oomph-lib.org.
// LIC//
// LIC// Copyright (C) 2006-2022 Matthias Heil and Andrew Hazel
// LIC//
// LIC// This library is free software; you can redistribute it and/or
// LIC// modify it under the terms of the GNU Lesser General Public
// LIC// License as published by the Free Software Foundation; either
// LIC// version 2.1 of the License, or (at your option) any later version.
// LIC//
// LIC// This library is distributed in the hope that it will be useful,
// LIC// but WITHOUT ANY WARRANTY; without even the implied warranty of
// LIC// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// LIC// Lesser General Public License for more details.
// LIC//
// LIC// You should have received a copy of the GNU Lesser General Public
// LIC// License along with this library; if not, write to the Free Software
// LIC// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
// LIC// 02110-1301  USA.
// LIC//
// LIC// The authors may be contacted at oomph-lib@maths.man.ac.uk.
// LIC//
// LIC//====================================================================
// Header file for multi-domain functions, including the class
// ElementWithExternalElement which stores pointers to external elements
 
// Temporary flag to enable full annotation of multi domain
// comms (but keep alive because it would be such a bloody pain to
// rewrite it if things ever go wrong again...)
//#define ANNOTATE_MULTI_DOMAIN_COMMUNICATION
 
// Include guards to prevent multiple inclusion of the header
#ifndef OOMPH_MULTI_DOMAIN_HEADER
#define OOMPH_MULTI_DOMAIN_HEADER
 
// Config header generated by autoconfig
#ifdef HAVE_CONFIG_H
#include <oomph-lib-config.h>
#endif
 
// Oomph-lib headers
#include "geom_objects.h"
#include "problem.h"
#include "shape.h"
 
#include "mesh.h"
#include "mesh_as_geometric_object.h"
#include "algebraic_elements.h"
#include "macro_element_node_update_element.h"
#include "Qelements.h"
#include "element_with_external_element.h"
 
 
namespace oomph
{
  //======================================================================
  // Namespace for global multi-domain functions
  //======================================================================
  namespace Multi_domain_functions
  {
    extern bool Accept_failed_locate_zeta_in_setup_multi_domain_interaction;
 
    extern unsigned Dim;
 
    extern Vector<Vector<unsigned>> External_element_located;
 
    extern Vector<double> Flat_packed_zetas_not_found_locally;
 
    extern Vector<double> Received_flat_packed_zetas_to_be_found;
 
    extern Vector<int> Proc_id_plus_one_of_external_element;
 
    extern Vector<unsigned> Located_element_status;
 
    extern Vector<double> Flat_packed_located_coordinates;
 
    extern Vector<double> Flat_packed_doubles;
 
    extern unsigned Counter_for_flat_packed_doubles;
 
    extern Vector<unsigned> Flat_packed_unsigneds;
 
#ifdef ANNOTATE_MULTI_DOMAIN_COMMUNICATION
 
    // Temporary vector of strings to enable full annotation of multi domain
    // comms (but keep alive because it would be such a bloody pain to
    // rewrite it if things ever go wrong again...)
    extern Vector<std::string> Flat_packed_unsigneds_string;
 
#endif
 
    extern unsigned Counter_for_flat_packed_unsigneds;
 
    enum
    {
      New,
      Exists,
      Not_found
    };
 
    extern bool Use_bulk_element_as_external;
 
    extern bool Allow_use_of_halo_elements_as_external_elements;
 
    extern bool Allow_use_of_halo_elements_as_external_elements_for_projection;
 
    extern bool Doc_timings;
 
    extern bool Doc_stats;
 
    extern bool Doc_full_stats;
 
    extern std::ofstream Doc_boundary_coordinate_file;
 
 
    // Functions for multi-domain method
 
    template<class BULK_ELEMENT, unsigned DIM>
    void setup_bulk_elements_adjacent_to_face_mesh(
      Problem* problem_pt,
      Vector<unsigned>& boundary_in_bulk_mesh,
      Mesh* const& bulk_mesh_pt,
      Vector<Mesh*>& face_mesh_pt,
      const unsigned& interaction = 0);
 
 
    template<class BULK_ELEMENT, unsigned DIM>
    void setup_bulk_elements_adjacent_to_face_mesh(
      Problem* problem_pt,
      const unsigned& boundary_in_bulk_mesh,
      Mesh* const& bulk_mesh_pt,
      Mesh* const& face_mesh_pt,
      const unsigned& interaction = 0);
 
    template<class ELEMENT_0, class ELEMENT_1>
    void setup_multi_domain_interactions(
      Problem* problem_pt,
      Mesh* const& first_mesh_pt,
      Mesh* const& second_mesh_pt,
      const unsigned& first_interaction = 0,
      const unsigned& second_interaction = 0);
 
    template<class EXT_ELEMENT>
    void setup_multi_domain_interaction(Problem* problem_pt,
                                        Mesh* const& mesh_pt,
                                        Mesh* const& external_mesh_pt,
                                        const unsigned& interaction_index = 0);
 
    template<class EXT_ELEMENT, class FACE_ELEMENT_GEOM_OBJECT>
    void setup_multi_domain_interaction(Problem* problem_pt,
                                        Mesh* const& mesh_pt,
                                        Mesh* const& external_mesh_pt,
                                        Mesh* const& external_face_mesh_pt,
                                        const unsigned& interaction_index = 0);
 
 
    template<class EXT_ELEMENT, class FACE_ELEMENT_GEOM_OBJECT>
    void setup_multi_domain_interaction(
      Problem* problem_pt,
      const Vector<Mesh*>& mesh_pt,
      Mesh* const& external_mesh_pt,
      const Vector<Mesh*>& external_face_mesh_pt,
      const unsigned& interaction_index = 0);
 
 
    template<class EXT_ELEMENT, class GEOM_OBJECT>
    void aux_setup_multi_domain_interaction(
      Problem* problem_pt,
      Mesh* const& mesh_pt,
      Mesh* const& external_mesh_pt,
      const unsigned& interaction_index,
      Mesh* const& external_face_mesh_pt = 0);
 
    template<class EXT_ELEMENT, class GEOM_OBJECT>
    void aux_setup_multi_domain_interaction(
      Problem* problem_pt,
      const Vector<Mesh*>& mesh_pt,
      Mesh* const& external_mesh_pt,
      const unsigned& interaction_index,
      const Vector<Mesh*>& external_face_mesh_pt);
 
    void locate_zeta_for_local_coordinates(
      const Vector<Mesh*>& mesh_pt,
      Mesh* const& external_mesh_pt,
      Vector<MeshAsGeomObject*>& mesh_geom_obj_pt,
      const unsigned& interaction_index);
 
 
#ifdef OOMPH_HAS_MPI
 
    void send_and_receive_missing_zetas(Problem* problem_pt);
 
    void locate_zeta_for_missing_coordinates(
      int& iproc,
      Mesh* const& external_mesh_pt,
      Problem* problem_pt,
      Vector<MeshAsGeomObject*>& mesh_geom_obj_pt);
 
 
    void send_and_receive_located_info(int& iproc,
                                       Mesh* const& external_mesh_pt,
                                       Problem* problem_pt);
 
    template<class EXT_ELEMENT>
    void create_external_halo_elements(int& iproc,
                                       const Vector<Mesh*>& mesh_pt,
                                       Mesh* const& external_mesh_pt,
                                       Problem* problem_pt,
                                       const unsigned& interaction_index);
 
    // Helper functions for external haloed node identification
 
    void add_external_haloed_node_to_storage(int& iproc,
                                             Node* nod_pt,
                                             Problem* problem_pt,
                                             Mesh* const& external_mesh_pt,
                                             int& n_cont_inter_values);
 
 
    void recursively_add_masters_of_external_haloed_node(
      int& iproc,
      Node* nod_pt,
      Problem* problem_pt,
      Mesh* const& external_mesh_pt,
      int& n_cont_inter_values);
 
 
    void add_external_haloed_node_helper(int& iproc,
                                         Node* nod_pt,
                                         Problem* problem_pt,
                                         Mesh* const& external_mesh_pt,
                                         int& n_cont_inter_values);
 
    void add_external_haloed_master_node_helper(int& iproc,
                                                Node* master_nod_pt,
                                                Problem* problem_pt,
                                                Mesh* const& external_mesh_pt,
                                                int& n_cont_inter_values);
 
    void get_required_nodal_information_helper(int& iproc,
                                               Node* nod_pt,
                                               Problem* problem_pt,
                                               Mesh* const& external_mesh_pt,
                                               int& n_cont_inter_values);
 
    void get_required_master_nodal_information_helper(
      int& iproc,
      Node* master_nod_pt,
      Problem* problem_pt,
      Mesh* const& external_mesh_pt,
      int& n_cont_inter_values);
 
    // Helper functions for external halo node identification
 
    template<class EXT_ELEMENT>
    void add_external_halo_node_to_storage(Node*& new_nod_pt,
                                           Mesh* const& external_mesh_pt,
                                           unsigned& loc_p,
                                           unsigned& node_index,
                                           FiniteElement* const& new_el_pt,
                                           int& n_cont_inter_values,
                                           Problem* problem_pt);
 
    template<class EXT_ELEMENT>
    void recursively_add_masters_of_external_halo_node_to_storage(
      Node*& new_nod_pt,
      Mesh* const& external_mesh_pt,
      unsigned& loc_p,
      unsigned& node_index,
      FiniteElement* const& new_el_pt,
      int& n_cont_inter_values,
      Problem* problem_pt);
 
 
    void add_external_halo_node_helper(Node*& new_nod_pt,
                                       Mesh* const& external_mesh_pt,
                                       unsigned& loc_p,
                                       unsigned& node_index,
                                       FiniteElement* const& new_el_pt,
                                       int& n_cont_inter_values,
                                       Problem* problem_pt);
 
    template<class EXT_ELEMENT>
    void add_external_halo_master_node_helper(Node*& new_master_nod_pt,
                                              Node*& new_nod_pt,
                                              Mesh* const& external_mesh_pt,
                                              unsigned& loc_p,
                                              int& n_cont_inter_values,
                                              Problem* problem_pt);
 
 
    void construct_new_external_halo_node_helper(
      Node*& new_nod_pt,
      unsigned& loc_p,
      unsigned& node_index,
      FiniteElement* const& new_el_pt,
      Mesh* const& external_mesh_pt,
      Problem* problem_pt);
 
    template<class EXT_ELEMENT>
    void construct_new_external_halo_master_node_helper(
      Node*& new_master_nod_pt,
      Node*& nod_pt,
      unsigned& loc_p,
      Mesh* const& external_mesh_pt,
      Problem* problem_pt);
 
#endif
 
    void get_dim_helper(Problem* problem_pt,
                        Mesh* const& mesh_pt,
                        Mesh* const& external_mesh_pt);
 
    void clean_up();
 
  } // namespace Multi_domain_functions
 
 
} // namespace oomph
 
#endif