helmholtz_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 Helmholtz elements
#ifndef OOMPH_HELMHOLTZ_ELEMENTS_HEADER
#define OOMPH_HELMHOLTZ_ELEMENTS_HEADER
 
 
// Config header generated by autoconfig
#ifdef HAVE_CONFIG_H
#include <oomph-lib-config.h>
#endif
 
 
// OOMPH-LIB headers
#include "../generic/projection.h"
#include "../generic/nodes.h"
#include "../generic/Qelements.h"
#include "../generic/oomph_utilities.h"
#include "math.h"
#include <complex>
 
namespace oomph
{
  //=============================================================
  //=============================================================
  template<unsigned DIM>
  class HelmholtzEquations : public virtual FiniteElement
  {
  public:
    typedef void (*HelmholtzSourceFctPt)(const Vector<double>& x,
                                         std::complex<double>& f);
 
 
    HelmholtzEquations() : Source_fct_pt(0), K_squared_pt(0) {}
 
    HelmholtzEquations(const HelmholtzEquations& dummy) = delete;
 
    // Commented out broken assignment operator because this can lead to a
    // conflict warning when used in the virtual inheritence hierarchy.
    // Essentially the compiler doesn't realise that two separate
    // implementations of the broken function are the same and so, quite
    // rightly, it shouts.
    /*void operator=(const HelmholtzEquations&) = delete;*/
 
    virtual inline std::complex<unsigned> u_index_helmholtz() const
    {
      return std::complex<unsigned>(0, 1);
    }
 
 
    double*& k_squared_pt()
    {
      return K_squared_pt;
    }
 
 
    double k_squared()
    {
#ifdef PARANOID
      if (K_squared_pt == 0)
      {
        throw OomphLibError(
          "Please set pointer to k_squared using access fct to pointer!",
          OOMPH_CURRENT_FUNCTION,
          OOMPH_EXCEPTION_LOCATION);
      }
#endif
      return *K_squared_pt;
    }
 
 
    unsigned nscalar_paraview() const
    {
      return 2;
    }
 
    void scalar_value_paraview(std::ofstream& file_out,
                               const unsigned& i,
                               const unsigned& nplot) const
    {
      // Vector of local coordinates
      Vector<double> s(DIM);
 
      // Loop over plot points
      unsigned num_plot_points = nplot_points_paraview(nplot);
      for (unsigned iplot = 0; iplot < num_plot_points; iplot++)
      {
        // Get local coordinates of plot point
        get_s_plot(iplot, nplot, s);
        std::complex<double> u(interpolated_u_helmholtz(s));
 
        // Paraview need to ouput the fileds seperatly so it loops through all
        // the elements twice
        switch (i)
        {
            // Real part first
          case 0:
            file_out << u.real() << std::endl;
            break;
 
            // Imaginary part second
          case 1:
            file_out << u.imag() << std::endl;
            break;
 
            // Never get here
          default:
            std::stringstream error_stream;
            error_stream
              << "Helmholtz elements only store 2 fields so i must be 0 or 1"
              << std::endl;
            throw OomphLibError(error_stream.str(),
                                OOMPH_CURRENT_FUNCTION,
                                OOMPH_EXCEPTION_LOCATION);
            break;
        }
      } // end of plotpoint loop
    } // end scalar_value_paraview
 
    std::string scalar_name_paraview(const unsigned& i) const
    {
      switch (i)
      {
        case 0:
          return "Real part";
          break;
 
        case 1:
          return "Imaginary part";
          break;
 
          // Never get here
        default:
          std::stringstream error_stream;
          error_stream
            << "Helmholtz elements only store 2 fields so i must be 0 or 1"
            << std::endl;
          throw OomphLibError(error_stream.str(),
                              OOMPH_CURRENT_FUNCTION,
                              OOMPH_EXCEPTION_LOCATION);
 
          // Dummy return for the default statement
          return " ";
          break;
      }
    }
 
    void output(std::ostream& outfile)
    {
      const unsigned n_plot = 5;
      output(outfile, n_plot);
    }
 
    void output(std::ostream& outfile, const unsigned& n_plot);
 
    void output_real(std::ostream& outfile,
                     const double& phi,
                     const unsigned& n_plot);
 
    void output(FILE* file_pt)
    {
      const unsigned n_plot = 5;
      output(file_pt, n_plot);
    }
 
    void output(FILE* file_pt, const unsigned& n_plot);
 
    void output_fct(std::ostream& outfile,
                    const unsigned& n_plot,
                    FiniteElement::SteadyExactSolutionFctPt exact_soln_pt);
 
    virtual void output_fct(
      std::ostream& outfile,
      const unsigned& n_plot,
      const double& time,
      FiniteElement::UnsteadyExactSolutionFctPt exact_soln_pt)
    {
      throw OomphLibError(
        "There is no time-dependent output_fct() for Helmholtz elements ",
        OOMPH_CURRENT_FUNCTION,
        OOMPH_EXCEPTION_LOCATION);
    }
 
 
    void output_real_fct(std::ostream& outfile,
                         const double& phi,
                         const unsigned& n_plot,
                         FiniteElement::SteadyExactSolutionFctPt exact_soln_pt);
 
 
    void compute_error(std::ostream& outfile,
                       FiniteElement::SteadyExactSolutionFctPt exact_soln_pt,
                       double& error,
                       double& norm);
 
 
    void compute_error(std::ostream& outfile,
                       FiniteElement::UnsteadyExactSolutionFctPt exact_soln_pt,
                       const double& time,
                       double& error,
                       double& norm)
    {
      throw OomphLibError(
        "There is no time-dependent compute_error() for Helmholtz elements",
        OOMPH_CURRENT_FUNCTION,
        OOMPH_EXCEPTION_LOCATION);
    }
 
    HelmholtzSourceFctPt& source_fct_pt()
    {
      return Source_fct_pt;
    }
 
    HelmholtzSourceFctPt source_fct_pt() const
    {
      return Source_fct_pt;
    }
 
 
    inline virtual void get_source_helmholtz(const unsigned& ipt,
                                             const Vector<double>& x,
                                             std::complex<double>& source) const
    {
      // If no source function has been set, return zero
      if (Source_fct_pt == 0)
      {
        source = std::complex<double>(0.0, 0.0);
      }
      else
      {
        // Get source strength
        (*Source_fct_pt)(x, source);
      }
    }
 
 
    void get_flux(const Vector<double>& s,
                  Vector<std::complex<double>>& flux) const
    {
      // Find out how many nodes there are in the element
      const unsigned n_node = nnode();
 
 
      // Set up memory for the shape and test functions
      Shape psi(n_node);
      DShape dpsidx(n_node, DIM);
 
      // Call the derivatives of the shape and test functions
      dshape_eulerian(s, psi, dpsidx);
 
      // Initialise to zero
      const std::complex<double> zero(0.0, 0.0);
      for (unsigned j = 0; j < DIM; j++)
      {
        flux[j] = zero;
      }
 
      // Loop over nodes
      for (unsigned l = 0; l < n_node; l++)
      {
        // Cache the complex value of the unknown
        const std::complex<double> u_value(
          this->nodal_value(l, u_index_helmholtz().real()),
          this->nodal_value(l, u_index_helmholtz().imag()));
        // Loop over derivative directions
        for (unsigned j = 0; j < DIM; j++)
        {
          flux[j] += u_value * dpsidx(l, j);
        }
      }
    }
 
 
    void fill_in_contribution_to_residuals(Vector<double>& residuals)
    {
      // Call the generic residuals function with flag set to 0
      // using a dummy matrix argument
      fill_in_generic_residual_contribution_helmholtz(
        residuals, GeneralisedElement::Dummy_matrix, 0);
    }
 
 
    void fill_in_contribution_to_jacobian(Vector<double>& residuals,
                                          DenseMatrix<double>& jacobian)
    {
      // Call the generic routine with the flag set to 1
      fill_in_generic_residual_contribution_helmholtz(residuals, jacobian, 1);
    }
 
 
    inline std::complex<double> interpolated_u_helmholtz(
      const Vector<double>& s) const
    {
      // Find number of nodes
      const unsigned n_node = nnode();
 
      // Local shape function
      Shape psi(n_node);
 
      // Find values of shape function
      shape(s, psi);
 
      // Initialise value of u
      std::complex<double> interpolated_u(0.0, 0.0);
 
      // Get the index at which the helmholtz unknown is stored
      const unsigned u_nodal_index_real = u_index_helmholtz().real();
      const unsigned u_nodal_index_imag = u_index_helmholtz().imag();
 
      // Loop over the local nodes and sum
      for (unsigned l = 0; l < n_node; l++)
      {
        // Make a temporary complex number from the stored data
        const std::complex<double> u_value(
          this->nodal_value(l, u_nodal_index_real),
          this->nodal_value(l, u_nodal_index_imag));
        // Add to the interpolated value
        interpolated_u += u_value * psi[l];
      }
      return interpolated_u;
    }
 
 
    unsigned self_test();
 
 
  protected:
    virtual double dshape_and_dtest_eulerian_helmholtz(
      const Vector<double>& s,
      Shape& psi,
      DShape& dpsidx,
      Shape& test,
      DShape& dtestdx) const = 0;
 
 
    virtual double dshape_and_dtest_eulerian_at_knot_helmholtz(
      const unsigned& ipt,
      Shape& psi,
      DShape& dpsidx,
      Shape& test,
      DShape& dtestdx) const = 0;
 
    virtual void fill_in_generic_residual_contribution_helmholtz(
      Vector<double>& residuals,
      DenseMatrix<double>& jacobian,
      const unsigned& flag);
 
    HelmholtzSourceFctPt Source_fct_pt;
 
    double* K_squared_pt;
  };
 
 
 
 
  //======================================================================
  //======================================================================
  template<unsigned DIM, unsigned NNODE_1D>
  class QHelmholtzElement : public virtual QElement<DIM, NNODE_1D>,
                            public virtual HelmholtzEquations<DIM>
  {
  private:
    static const unsigned Initial_Nvalue;
 
  public:
    QHelmholtzElement() : QElement<DIM, NNODE_1D>(), HelmholtzEquations<DIM>()
    {
    }
 
    QHelmholtzElement(const QHelmholtzElement<DIM, NNODE_1D>& dummy) = delete;
 
    /*void operator=(const QHelmholtzElement<DIM,NNODE_1D>&) = delete;*/
 
 
    inline unsigned required_nvalue(const unsigned& n) const
    {
      return Initial_Nvalue;
    }
 
    void output(std::ostream& outfile)
    {
      HelmholtzEquations<DIM>::output(outfile);
    }
 
 
    void output(std::ostream& outfile, const unsigned& n_plot)
    {
      HelmholtzEquations<DIM>::output(outfile, n_plot);
    }
 
    void output_real(std::ostream& outfile,
                     const double& phi,
                     const unsigned& n_plot)
    {
      HelmholtzEquations<DIM>::output_real(outfile, phi, n_plot);
    }
 
 
    void output(FILE* file_pt)
    {
      HelmholtzEquations<DIM>::output(file_pt);
    }
 
 
    void output(FILE* file_pt, const unsigned& n_plot)
    {
      HelmholtzEquations<DIM>::output(file_pt, n_plot);
    }
 
 
    void output_fct(std::ostream& outfile,
                    const unsigned& n_plot,
                    FiniteElement::SteadyExactSolutionFctPt exact_soln_pt)
    {
      HelmholtzEquations<DIM>::output_fct(outfile, n_plot, exact_soln_pt);
    }
 
 
    void output_real_fct(std::ostream& outfile,
                         const double& phi,
                         const unsigned& n_plot,
                         FiniteElement::SteadyExactSolutionFctPt exact_soln_pt)
    {
      HelmholtzEquations<DIM>::output_real_fct(
        outfile, phi, n_plot, exact_soln_pt);
    }
 
 
    void output_fct(std::ostream& outfile,
                    const unsigned& n_plot,
                    const double& time,
                    FiniteElement::UnsteadyExactSolutionFctPt exact_soln_pt)
    {
      HelmholtzEquations<DIM>::output_fct(outfile, n_plot, time, exact_soln_pt);
    }
 
 
  protected:
    inline double dshape_and_dtest_eulerian_helmholtz(const Vector<double>& s,
                                                      Shape& psi,
                                                      DShape& dpsidx,
                                                      Shape& test,
                                                      DShape& dtestdx) const;
 
 
    inline double dshape_and_dtest_eulerian_at_knot_helmholtz(
      const unsigned& ipt,
      Shape& psi,
      DShape& dpsidx,
      Shape& test,
      DShape& dtestdx) const;
  };
 
 
  // Inline functions:
 
 
  //======================================================================
  //======================================================================
  template<unsigned DIM, unsigned NNODE_1D>
  double QHelmholtzElement<DIM, NNODE_1D>::dshape_and_dtest_eulerian_helmholtz(
    const Vector<double>& s,
    Shape& psi,
    DShape& dpsidx,
    Shape& test,
    DShape& dtestdx) const
  {
    // Call the geometrical shape functions and derivatives
    const double J = this->dshape_eulerian(s, psi, dpsidx);
 
    // Set the test functions equal to the shape functions
    test = psi;
    dtestdx = dpsidx;
 
    // Return the jacobian
    return J;
  }
 
 
  //======================================================================
  //======================================================================
  template<unsigned DIM, unsigned NNODE_1D>
  double QHelmholtzElement<DIM, NNODE_1D>::
    dshape_and_dtest_eulerian_at_knot_helmholtz(const unsigned& ipt,
                                                Shape& psi,
                                                DShape& dpsidx,
                                                Shape& test,
                                                DShape& dtestdx) const
  {
    // Call the geometrical shape functions and derivatives
    const double J = this->dshape_eulerian_at_knot(ipt, psi, dpsidx);
 
    // Set the pointers of the test functions
    test = psi;
    dtestdx = dpsidx;
 
    // Return the jacobian
    return J;
  }
 
 
 
  //=======================================================================
  //=======================================================================
  template<unsigned DIM, unsigned NNODE_1D>
  class FaceGeometry<QHelmholtzElement<DIM, NNODE_1D>>
    : public virtual QElement<DIM - 1, NNODE_1D>
  {
  public:
    FaceGeometry() : QElement<DIM - 1, NNODE_1D>() {}
  };
 
 
 
  //=======================================================================
  //=======================================================================
  template<unsigned NNODE_1D>
  class FaceGeometry<QHelmholtzElement<1, NNODE_1D>>
    : public virtual PointElement
  {
  public:
    FaceGeometry() : PointElement() {}
  };
 
 
 
 
  //==========================================================
  //==========================================================
  template<class HELMHOLTZ_ELEMENT>
  class ProjectableHelmholtzElement
    : public virtual ProjectableElement<HELMHOLTZ_ELEMENT>
  {
  public:
    ProjectableHelmholtzElement() {}
 
    Vector<std::pair<Data*, unsigned>> data_values_of_field(const unsigned& fld)
    {
#ifdef PARANOID
      if (fld > 1)
      {
        std::stringstream error_stream;
        error_stream << "Helmholtz elements only store 2 fields so fld = "
                     << fld << " is illegal \n";
        throw OomphLibError(
          error_stream.str(), OOMPH_CURRENT_FUNCTION, OOMPH_EXCEPTION_LOCATION);
      }
#endif
 
      // Create the vector
      unsigned nnod = this->nnode();
      Vector<std::pair<Data*, unsigned>> data_values(nnod);
 
      // Loop over all nodes
      for (unsigned j = 0; j < nnod; j++)
      {
        // Add the data value associated field: The node itself
        data_values[j] = std::make_pair(this->node_pt(j), fld);
      }
 
      // Return the vector
      return data_values;
    }
 
    unsigned nfields_for_projection()
    {
      return 2;
    }
 
    unsigned nhistory_values_for_projection(const unsigned& fld)
    {
#ifdef PARANOID
      if (fld > 1)
      {
        std::stringstream error_stream;
        error_stream << "Helmholtz elements only store two fields so fld = "
                     << fld << " is illegal\n";
        throw OomphLibError(
          error_stream.str(), OOMPH_CURRENT_FUNCTION, OOMPH_EXCEPTION_LOCATION);
      }
#endif
      return this->node_pt(0)->ntstorage();
    }
 
    unsigned nhistory_values_for_coordinate_projection()
    {
      return this->node_pt(0)->position_time_stepper_pt()->ntstorage();
    }
 
    double jacobian_and_shape_of_field(const unsigned& fld,
                                       const Vector<double>& s,
                                       Shape& psi)
    {
#ifdef PARANOID
      if (fld > 1)
      {
        std::stringstream error_stream;
        error_stream << "Helmholtz elements only store two fields so fld = "
                     << fld << " is illegal.\n";
        throw OomphLibError(
          error_stream.str(), OOMPH_CURRENT_FUNCTION, OOMPH_EXCEPTION_LOCATION);
      }
#endif
      unsigned n_dim = this->dim();
      unsigned n_node = this->nnode();
      Shape test(n_node);
      DShape dpsidx(n_node, n_dim), dtestdx(n_node, n_dim);
      double J = this->dshape_and_dtest_eulerian_helmholtz(
        s, psi, dpsidx, test, dtestdx);
      return J;
    }
 
 
    double get_field(const unsigned& t,
                     const unsigned& fld,
                     const Vector<double>& s)
    {
#ifdef PARANOID
      if (fld > 1)
      {
        std::stringstream error_stream;
        error_stream << "Helmholtz elements only store two fields so fld = "
                     << fld << " is illegal\n";
        throw OomphLibError(
          error_stream.str(), OOMPH_CURRENT_FUNCTION, OOMPH_EXCEPTION_LOCATION);
      }
#endif
      // Find the index at which the variable is stored
      std::complex<unsigned> complex_u_nodal_index = this->u_index_helmholtz();
      unsigned u_nodal_index = 0;
      if (fld == 0)
      {
        u_nodal_index = complex_u_nodal_index.real();
      }
      else
      {
        u_nodal_index = complex_u_nodal_index.imag();
      }
 
 
      // Local shape function
      unsigned n_node = this->nnode();
      Shape psi(n_node);
 
      // Find values of shape function
      this->shape(s, psi);
 
      // Initialise value of u
      double interpolated_u = 0.0;
 
      // Sum over the local nodes
      for (unsigned l = 0; l < n_node; l++)
      {
        interpolated_u += this->nodal_value(t, l, u_nodal_index) * psi[l];
      }
      return interpolated_u;
    }
 
 
    unsigned nvalue_of_field(const unsigned& fld)
    {
#ifdef PARANOID
      if (fld > 1)
      {
        std::stringstream error_stream;
        error_stream << "Helmholtz elements only store two fields so fld = "
                     << fld << " is illegal\n";
        throw OomphLibError(
          error_stream.str(), OOMPH_CURRENT_FUNCTION, OOMPH_EXCEPTION_LOCATION);
      }
#endif
      return this->nnode();
    }
 
 
    int local_equation(const unsigned& fld, const unsigned& j)
    {
#ifdef PARANOID
      if (fld > 1)
      {
        std::stringstream error_stream;
        error_stream << "Helmholtz elements only store two fields so fld = "
                     << fld << " is illegal\n";
        throw OomphLibError(
          error_stream.str(), OOMPH_CURRENT_FUNCTION, OOMPH_EXCEPTION_LOCATION);
      }
#endif
      std::complex<unsigned> complex_u_nodal_index = this->u_index_helmholtz();
      unsigned u_nodal_index = 0;
      if (fld == 0)
      {
        u_nodal_index = complex_u_nodal_index.real();
      }
      else
      {
        u_nodal_index = complex_u_nodal_index.imag();
      }
      return this->nodal_local_eqn(j, u_nodal_index);
    }
 
 
    void output(std::ostream& outfile, const unsigned& nplot)
    {
      HELMHOLTZ_ELEMENT::output(outfile, nplot);
    }
  };
 
 
  //=======================================================================
  //=======================================================================
  template<class ELEMENT>
  class FaceGeometry<ProjectableHelmholtzElement<ELEMENT>>
    : public virtual FaceGeometry<ELEMENT>
  {
  public:
    FaceGeometry() : FaceGeometry<ELEMENT>() {}
  };
 
 
  //=======================================================================
  //=======================================================================
  template<class ELEMENT>
  class FaceGeometry<FaceGeometry<ProjectableHelmholtzElement<ELEMENT>>>
    : public virtual FaceGeometry<FaceGeometry<ELEMENT>>
  {
  public:
    FaceGeometry() : FaceGeometry<FaceGeometry<ELEMENT>>() {}
  };
 
 
} // namespace oomph
 
#endif