refineable_spherical_navier_stokes_elements.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 refineable axisymmetric quad Navier Stokes elements
#ifndef OOMPH_REFINEABLE_SPHERICAL_NAVIER_STOKES_ELEMENTS_HEADER
#define OOMPH_REFINEABLE_SPHERICAL_NAVIER_STOKES_ELEMENTS_HEADER
 
// Config header generated by autoconfig
#ifdef HAVE_CONFIG_H
#include <oomph-lib-config.h>
#endif
 
// Oomph lib includes
#include "../generic/refineable_quad_element.h"
#include "../generic/error_estimator.h"
#include "spherical_navier_stokes_elements.h"
 
namespace oomph
{
  //======================================================================
  //======================================================================
  class RefineableSphericalNavierStokesEquations
    : public virtual SphericalNavierStokesEquations,
      public virtual RefineableElement,
      public virtual ElementWithZ2ErrorEstimator
  {
  protected:
    virtual Node* pressure_node_pt(const unsigned& n_p)
    {
      return NULL;
    }
 
    virtual void unpin_elemental_pressure_dofs() = 0;
 
    virtual void pin_elemental_redundant_nodal_pressure_dofs() {}
 
  public:
    RefineableSphericalNavierStokesEquations()
      : SphericalNavierStokesEquations(),
        RefineableElement(),
        ElementWithZ2ErrorEstimator()
    {
    }
 
    unsigned num_Z2_flux_terms()
    {
      // 3 diagonal strain rates, 3 off diagonal
      return 6;
    }
 
    void get_Z2_flux(const Vector<double>& s, Vector<double>& flux)
    {
      // Specify the number of velocity dimensions
      unsigned DIM = 3;
#ifdef PARANOID
      unsigned num_entries = DIM + ((DIM * DIM) - DIM) / 2;
      if (flux.size() < num_entries)
      {
        std::ostringstream error_message;
        error_message << "The flux vector is too small, size " << flux.size()
                      << ", whereas it should be " << num_entries << std::endl;
        throw OomphLibError(error_message.str(),
                            OOMPH_CURRENT_FUNCTION,
                            OOMPH_EXCEPTION_LOCATION);
      }
#endif
      // Get strain rate matrix
      DenseMatrix<double> strainrate(DIM);
      this->strain_rate(s, strainrate);
 
      // Pack into flux Vector
      unsigned icount = 0;
 
      // Start with diagonal terms
      for (unsigned i = 0; i < DIM; i++)
      {
        flux[icount] = strainrate(i, i);
        icount++;
      }
 
      // Off diagonals row by row
      for (unsigned i = 0; i < DIM; i++)
      {
        for (unsigned j = i + 1; j < DIM; j++)
        {
          flux[icount] = strainrate(i, j);
          icount++;
        }
      }
    }
 
    double geometric_jacobian(const Vector<double>& x)
    {
      return x[0] * x[0] * sin(x[1]);
    }
 
 
    void further_build()
    {
      // Find the father element
      RefineableSphericalNavierStokesEquations* cast_father_element_pt =
        dynamic_cast<RefineableSphericalNavierStokesEquations*>(
          this->father_element_pt());
 
      // Set the viscosity ratio pointer
      this->Viscosity_Ratio_pt = cast_father_element_pt->viscosity_ratio_pt();
      // Set the density ratio pointer
      this->Density_Ratio_pt = cast_father_element_pt->density_ratio_pt();
      // Set pointer to global Reynolds number
      this->Re_pt = cast_father_element_pt->re_pt();
      // Set pointer to global Reynolds number x Strouhal number (=Womersley)
      this->ReSt_pt = cast_father_element_pt->re_st_pt();
      // Set pointer to the global Reynolds number x inverse Rossby number
      this->ReInvRo_pt = cast_father_element_pt->re_invro_pt();
      // Set pointer to global Reynolds number x inverse Froude number
      this->ReInvFr_pt = cast_father_element_pt->re_invfr_pt();
      // Set pointer to global gravity Vector
      this->G_pt = cast_father_element_pt->g_pt();
 
      // Set pointer to body force function
      this->Body_force_fct_pt = cast_father_element_pt->body_force_fct_pt();
 
      // Set pointer to volumetric source function
      this->Source_fct_pt = cast_father_element_pt->source_fct_pt();
 
      // Set the ALE flag
      this->ALE_is_disabled = cast_father_element_pt->ALE_is_disabled;
    }
 
    static void pin_redundant_nodal_pressures(
      const Vector<GeneralisedElement*>& element_pt)
    {
      // Loop over all elements to brutally pin all nodal pressure degrees of
      // freedom
      unsigned n_element = element_pt.size();
      for (unsigned e = 0; e < n_element; e++)
      {
        dynamic_cast<RefineableSphericalNavierStokesEquations*>(element_pt[e])
          ->pin_elemental_redundant_nodal_pressure_dofs();
      }
    }
 
    static void unpin_all_pressure_dofs(
      const Vector<GeneralisedElement*>& element_pt)
    {
      // Loop over all elements to brutally unpin all nodal pressure degrees of
      // freedom and internal pressure degrees of freedom
      unsigned n_element = element_pt.size();
      for (unsigned e = 0; e < n_element; e++)
      {
        dynamic_cast<RefineableSphericalNavierStokesEquations*>(element_pt[e])
          ->unpin_elemental_pressure_dofs();
      }
    }
 
 
  private:
    void fill_in_generic_residual_contribution_spherical_nst(
      Vector<double>& residuals,
      DenseMatrix<double>& jacobian,
      DenseMatrix<double>& mass_matrix,
      unsigned flag);
  };
 
  //======================================================================
  //======================================================================
  class RefineableQSphericalTaylorHoodElement
    : public QSphericalTaylorHoodElement,
      public virtual RefineableSphericalNavierStokesEquations,
      public virtual RefineableQElement<2>
  {
  private:
    Node* pressure_node_pt(const unsigned& n_p)
    {
      return this->node_pt(this->Pconv[n_p]);
    }
 
    void unpin_elemental_pressure_dofs()
    {
      unsigned n_node = this->nnode();
      int p_index = this->p_nodal_index_spherical_nst();
      // loop over nodes
      for (unsigned n = 0; n < n_node; n++)
      {
        this->node_pt(n)->unpin(p_index);
      }
    }
 
    void pin_elemental_redundant_nodal_pressure_dofs()
    {
      // Loop over all nodes
      unsigned n_node = this->nnode();
      int p_index = this->p_nodal_index_spherical_nst();
      // loop over all nodes and pin all  the nodal pressures
      for (unsigned n = 0; n < n_node; n++)
      {
        this->node_pt(n)->pin(p_index);
      }
 
      // Loop over all actual pressure nodes and unpin if they're not hanging
      unsigned n_pres = this->npres_spherical_nst();
      for (unsigned l = 0; l < n_pres; l++)
      {
        Node* nod_pt = this->node_pt(this->Pconv[l]);
        if (!nod_pt->is_hanging(p_index))
        {
          nod_pt->unpin(p_index);
        }
      }
    }
 
  public:
    RefineableQSphericalTaylorHoodElement()
      : RefineableElement(),
        RefineableSphericalNavierStokesEquations(),
        RefineableQElement<2>(),
        QSphericalTaylorHoodElement()
    {
    }
 
    // Bumped up to 4 so we don't have to worry if a hanging mid-side node
    // gets shared by a corner node (which has extra degrees of freedom)
    unsigned required_nvalue(const unsigned& n) const
    {
      return 4;
    }
 
    unsigned ncont_interpolated_values() const
    {
      return 4;
    }
 
    void rebuild_from_sons(Mesh*& mesh_pt) {}
 
    unsigned nrecovery_order()
    {
      return 2;
    }
 
    unsigned nvertex_node() const
    {
      return QSphericalTaylorHoodElement::nvertex_node();
    }
 
    Node* vertex_node_pt(const unsigned& j) const
    {
      return QSphericalTaylorHoodElement::vertex_node_pt(j);
    }
 
    void get_interpolated_values(const Vector<double>& s,
                                 Vector<double>& values)
    {
      // Set size of values Vector: u,w,v,p and initialise to zero
      values.resize(4, 0.0);
 
      // Calculate three velocities: values[0],...
      for (unsigned i = 0; i < 3; i++)
      {
        values[i] = interpolated_u_spherical_nst(s, i);
      }
 
      // Calculate pressure: values[3]
      values[3] = interpolated_p_spherical_nst(s);
    }
 
    void get_interpolated_values(const unsigned& t,
                                 const Vector<double>& s,
                                 Vector<double>& values)
    {
      // Set size of Vector: u,w,v,p
      values.resize(4);
 
      // Initialise
      for (unsigned i = 0; i < 4; i++)
      {
        values[i] = 0.0;
      }
 
      // Find out how many nodes there are
      unsigned n_node = nnode();
 
      // Shape functions
      Shape psif(n_node);
      shape(s, psif);
 
      // Calculate velocities: values[0],...
      for (unsigned i = 0; i < 3; i++)
      {
        // Get the nodal coordinate of the velocity
        const unsigned u_nodal_index = u_index_spherical_nst(i);
        for (unsigned l = 0; l < n_node; l++)
        {
          values[i] += nodal_value(t, l, u_nodal_index) * psif[l];
        }
      }
 
      // Calculate pressure: values[3]
      //(no history is carried in the pressure)
      values[3] = interpolated_p_spherical_nst(s);
    }
 
    void further_setup_hanging_nodes()
    {
      this->setup_hang_for_value(3);
    }
 
    Node* interpolating_node_pt(const unsigned& n, const int& n_value)
 
    {
      // The only different nodes are the pressure nodes
      if (n_value == 3)
      {
        return this->node_pt(this->Pconv[n]);
      }
      // The other variables are interpolated via the usual nodes
      else
      {
        return this->node_pt(n);
      }
    }
 
    double local_one_d_fraction_of_interpolating_node(const unsigned& n1d,
                                                      const unsigned& i,
                                                      const int& n_value)
    {
      if (n_value == 3)
      {
        // The pressure nodes are just located on the boundaries at 0 or 1
        return double(n1d);
      }
      // Otherwise the velocity nodes are the same as the geometric ones
      else
      {
        return this->local_one_d_fraction_of_node(n1d, i);
      }
    }
 
    Node* get_interpolating_node_at_local_coordinate(const Vector<double>& s,
                                                     const int& n_value)
    {
      // If we are calculating pressure nodes
      if (n_value == 3)
      {
        // Storage for the index of the pressure node
        unsigned total_index = 0;
        // The number of nodes along each 1d edge is 2.
        unsigned NNODE_1D = 2;
        // Storage for the index along each boundary
        // Note that it's only a 2D spatial element
        Vector<int> index(2);
        // Loop over the coordinates
        for (unsigned i = 0; i < 2; i++)
        {
          // If we are at the lower limit, the index is zero
          if (s[i] == -1.0)
          {
            index[i] = 0;
          }
          // If we are at the upper limit, the index is the number of nodes
          // minus 1
          else if (s[i] == 1.0)
          {
            index[i] = NNODE_1D - 1;
          }
          // Otherwise, we have to calculate the index in general
          else
          {
            // For uniformly spaced nodes the 0th node number would be
            double float_index = 0.5 * (1.0 + s[i]) * (NNODE_1D - 1);
            index[i] = int(float_index);
            // What is the excess. This should be safe because the
            // taking the integer part rounds down
            double excess = float_index - index[i];
            // If the excess is bigger than our tolerance there is no node,
            // return null
            if ((excess > FiniteElement::Node_location_tolerance) &&
                ((1.0 - excess) > FiniteElement::Node_location_tolerance))
            {
              return 0;
            }
          }
          total_index +=
            index[i] * static_cast<unsigned>(pow(static_cast<float>(NNODE_1D),
                                                 static_cast<int>(i)));
        }
        // If we've got here we have a node, so let's return a pointer to it
        return this->node_pt(this->Pconv[total_index]);
      }
      // Otherwise velocity nodes are the same as pressure nodes
      else
      {
        return this->get_node_at_local_coordinate(s);
      }
    }
 
 
    unsigned ninterpolating_node_1d(const int& n_value)
    {
      if (n_value == 3)
      {
        return 2;
      }
      else
      {
        return this->nnode_1d();
      }
    }
 
    unsigned ninterpolating_node(const int& n_value)
    {
      if (n_value == 3)
      {
        return 4;
      }
      else
      {
        return this->nnode();
      }
    }
 
    void interpolating_basis(const Vector<double>& s,
                             Shape& psi,
                             const int& n_value) const
    {
      if (n_value == 3)
      {
        return this->pshape_spherical_nst(s, psi);
      }
      else
      {
        return this->shape(s, psi);
      }
    }
  };
 
 
 
  //=======================================================================
  //=======================================================================
  template<>
  class FaceGeometry<RefineableQSphericalTaylorHoodElement>
    : public virtual FaceGeometry<QSphericalTaylorHoodElement>
  {
  public:
    FaceGeometry() : FaceGeometry<QSphericalTaylorHoodElement>() {}
  };
 
 
  //=======================================================================
  //=======================================================================
  template<>
  class FaceGeometry<FaceGeometry<RefineableQSphericalTaylorHoodElement>>
    : public virtual FaceGeometry<FaceGeometry<QSphericalTaylorHoodElement>>
  {
  public:
    FaceGeometry() : FaceGeometry<FaceGeometry<QSphericalTaylorHoodElement>>()
    {
    }
  };
 
 
  //======================================================================
  //======================================================================
  class RefineableQSphericalCrouzeixRaviartElement
    : public QSphericalCrouzeixRaviartElement,
      public virtual RefineableSphericalNavierStokesEquations,
      public virtual RefineableQElement<2>
  {
  private:
    void unpin_elemental_pressure_dofs()
    {
      unsigned n_pres = this->npres_spherical_nst();
      // loop over pressure dofs and unpin
      for (unsigned l = 0; l < n_pres; l++)
      {
        this->internal_data_pt(P_spherical_nst_internal_index)->unpin(l);
      }
    }
 
  public:
    RefineableQSphericalCrouzeixRaviartElement()
      : RefineableElement(),
        RefineableSphericalNavierStokesEquations(),
        RefineableQElement<2>(),
        QSphericalCrouzeixRaviartElement()
    {
    }
 
    unsigned ncont_interpolated_values() const
    {
      return 3;
    }
 
    void rebuild_from_sons(Mesh*& mesh_pt)
    {
      using namespace QuadTreeNames;
 
      // Central pressure value:
      //-----------------------
 
      // Use average of the sons central pressure values
      // Other options: Take average of the four (discontinuous)
      // pressure values at the father's midpoint]
 
      double av_press = 0.0;
 
      // Loop over the sons
      for (unsigned ison = 0; ison < 4; ison++)
      {
        // Add the sons midnode pressure
        av_press += quadtree_pt()
                      ->son_pt(ison)
                      ->object_pt()
                      ->internal_data_pt(P_spherical_nst_internal_index)
                      ->value(0);
      }
 
      // Use the average
      internal_data_pt(P_spherical_nst_internal_index)
        ->set_value(0, 0.25 * av_press);
 
 
      // Slope in s_0 direction
      //----------------------
 
      // Use average of the 2 FD approximations based on the
      // elements central pressure values
      // [Other options: Take average of the four
      // pressure derivatives]
 
      double slope1 = quadtree_pt()
                        ->son_pt(SE)
                        ->object_pt()
                        ->internal_data_pt(P_spherical_nst_internal_index)
                        ->value(0) -
                      quadtree_pt()
                        ->son_pt(SW)
                        ->object_pt()
                        ->internal_data_pt(P_spherical_nst_internal_index)
                        ->value(0);
 
      double slope2 = quadtree_pt()
                        ->son_pt(NE)
                        ->object_pt()
                        ->internal_data_pt(P_spherical_nst_internal_index)
                        ->value(0) -
                      quadtree_pt()
                        ->son_pt(NW)
                        ->object_pt()
                        ->internal_data_pt(P_spherical_nst_internal_index)
                        ->value(0);
 
 
      // Use the average
      internal_data_pt(P_spherical_nst_internal_index)
        ->set_value(1, 0.5 * (slope1 + slope2));
 
 
      // Slope in s_1 direction
      //----------------------
 
      // Use average of the 2 FD approximations based on the
      // elements central pressure values
      // [Other options: Take average of the four
      // pressure derivatives]
 
      slope1 = quadtree_pt()
                 ->son_pt(NE)
                 ->object_pt()
                 ->internal_data_pt(P_spherical_nst_internal_index)
                 ->value(0) -
               quadtree_pt()
                 ->son_pt(SE)
                 ->object_pt()
                 ->internal_data_pt(P_spherical_nst_internal_index)
                 ->value(0);
 
      slope2 = quadtree_pt()
                 ->son_pt(NW)
                 ->object_pt()
                 ->internal_data_pt(P_spherical_nst_internal_index)
                 ->value(0) -
               quadtree_pt()
                 ->son_pt(SW)
                 ->object_pt()
                 ->internal_data_pt(P_spherical_nst_internal_index)
                 ->value(0);
 
 
      // Use the average
      internal_data_pt(P_spherical_nst_internal_index)
        ->set_value(2, 0.5 * (slope1 + slope2));
    }
 
    unsigned nrecovery_order()
    {
      return 2;
    }
 
    unsigned nvertex_node() const
    {
      return QSphericalCrouzeixRaviartElement::nvertex_node();
    }
 
    Node* vertex_node_pt(const unsigned& j) const
    {
      return QSphericalCrouzeixRaviartElement::vertex_node_pt(j);
    }
 
    void get_interpolated_values(const Vector<double>& s,
                                 Vector<double>& values)
    {
      // Set size of Vector: u,w,v and initialise to zero
      values.resize(3, 0.0);
 
      // Calculate velocities: values[0],...
      for (unsigned i = 0; i < 3; i++)
      {
        values[i] = interpolated_u_spherical_nst(s, i);
      }
    }
 
    void get_interpolated_values(const unsigned& t,
                                 const Vector<double>& s,
                                 Vector<double>& values)
    {
      // Set size of Vector: u,w,v
      values.resize(3);
 
      // Initialise
      for (unsigned i = 0; i < 3; i++)
      {
        values[i] = 0.0;
      }
 
      // Find out how many nodes there are
      unsigned n_node = nnode();
 
      // Shape functions
      Shape psif(n_node);
      shape(s, psif);
 
      // Calculate velocities: values[0],...
      for (unsigned i = 0; i < 3; i++)
      {
        // Get the local index at which the i-th velocity is stored
        unsigned u_local_index = u_index_spherical_nst(i);
        for (unsigned l = 0; l < n_node; l++)
        {
          values[i] += nodal_value(t, l, u_local_index) * psif[l];
        }
      }
    }
 
    void further_setup_hanging_nodes() {}
 
    void further_build()
    {
      // Call the generic further build
      RefineableSphericalNavierStokesEquations::further_build();
 
      using namespace QuadTreeNames;
 
      // What type of son am I? Ask my quadtree representation...
      int son_type = quadtree_pt()->son_type();
 
      // Pointer to my father (in element impersonation)
      RefineableElement* father_el_pt = quadtree_pt()->father_pt()->object_pt();
 
      Vector<double> s_father(2);
 
      // Son midpoint is located at the following coordinates in father element:
 
      // South west son
      if (son_type == SW)
      {
        s_father[0] = -0.5;
        s_father[1] = -0.5;
      }
      // South east son
      else if (son_type == SE)
      {
        s_father[0] = 0.5;
        s_father[1] = -0.5;
      }
      // North east son
      else if (son_type == NE)
      {
        s_father[0] = 0.5;
        s_father[1] = 0.5;
      }
 
      // North west son
      else if (son_type == NW)
      {
        s_father[0] = -0.5;
        s_father[1] = 0.5;
      }
 
      // Pressure value in father element
      RefineableQSphericalCrouzeixRaviartElement* cast_father_el_pt =
        dynamic_cast<RefineableQSphericalCrouzeixRaviartElement*>(father_el_pt);
      double press = cast_father_el_pt->interpolated_p_spherical_nst(s_father);
 
      // Pressure value gets copied straight into internal dof:
      internal_data_pt(P_spherical_nst_internal_index)->set_value(0, press);
 
 
      // The slopes get copied from father
      internal_data_pt(P_spherical_nst_internal_index)
        ->set_value(1,
                    0.5 * cast_father_el_pt
                            ->internal_data_pt(P_spherical_nst_internal_index)
                            ->value(1));
 
      internal_data_pt(P_spherical_nst_internal_index)
        ->set_value(2,
                    0.5 * cast_father_el_pt
                            ->internal_data_pt(P_spherical_nst_internal_index)
                            ->value(2));
    }
  };
 
 
  //=======================================================================
  //=======================================================================
  template<>
  class FaceGeometry<RefineableQSphericalCrouzeixRaviartElement>
    : public virtual FaceGeometry<QSphericalCrouzeixRaviartElement>
  {
  public:
    FaceGeometry() : FaceGeometry<QSphericalCrouzeixRaviartElement>() {}
  };
 
 
  //=======================================================================
  //=======================================================================
  template<>
  class FaceGeometry<FaceGeometry<RefineableQSphericalCrouzeixRaviartElement>>
    : public virtual FaceGeometry<
        FaceGeometry<QSphericalCrouzeixRaviartElement>>
  {
  public:
    FaceGeometry()
      : FaceGeometry<FaceGeometry<QSphericalCrouzeixRaviartElement>>()
    {
    }
  };
 
 
} // namespace oomph
 
#endif