gen_advection_diffusion_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 Advection Diffusion elements
#ifndef OOMPH_GEN_ADV_DIFF_ELEMENTS_HEADER
#define OOMPH_GEN_ADV_DIFF_ELEMENTS_HEADER
 
 
// Config header generated by autoconfig
#ifdef HAVE_CONFIG_H
#include <oomph-lib-config.h>
#endif
 
// OOMPH-LIB headers
#include "../generic/nodes.h"
#include "../generic/Qelements.h"
#include "../generic/oomph_utilities.h"
 
namespace oomph
{
  //=============================================================
  //=============================================================
  template<unsigned DIM>
  class GeneralisedAdvectionDiffusionEquations : public virtual FiniteElement
  {
  public:
    typedef void (*GeneralisedAdvectionDiffusionSourceFctPt)(
      const Vector<double>& x, double& f);
 
    typedef void (*GeneralisedAdvectionDiffusionWindFctPt)(
      const Vector<double>& x, Vector<double>& wind);
 
 
    typedef void (*GeneralisedAdvectionDiffusionDiffFctPt)(
      const Vector<double>& x, DenseMatrix<double>& D);
 
    GeneralisedAdvectionDiffusionEquations()
      : Source_fct_pt(0),
        Wind_fct_pt(0),
        Conserved_wind_fct_pt(0),
        Diff_fct_pt(0),
        ALE_is_disabled(false)
    {
      // Set Peclet number to default
      Pe_pt = &Default_peclet_number;
      // Set Peclet Strouhal number to default
      PeSt_pt = &Default_peclet_number;
    }
 
    GeneralisedAdvectionDiffusionEquations(
      const GeneralisedAdvectionDiffusionEquations& dummy) = delete;
 
    void operator=(const GeneralisedAdvectionDiffusionEquations&) = delete;
 
    virtual inline unsigned u_index_cons_adv_diff() const
    {
      return 0;
    }
 
    double du_dt_cons_adv_diff(const unsigned& n) const
    {
      // Get the data's timestepper
      TimeStepper* time_stepper_pt = this->node_pt(n)->time_stepper_pt();
 
      // Initialise dudt
      double dudt = 0.0;
      // Loop over the timesteps, if there is a non Steady timestepper
      if (!time_stepper_pt->is_steady())
      {
        // Find the index at which the variable is stored
        const unsigned u_nodal_index = u_index_cons_adv_diff();
 
        // Number of timsteps (past & present)
        const unsigned n_time = time_stepper_pt->ntstorage();
 
        for (unsigned t = 0; t < n_time; t++)
        {
          dudt +=
            time_stepper_pt->weight(1, t) * nodal_value(t, n, u_nodal_index);
        }
      }
      return dudt;
    }
 
    void disable_ALE()
    {
      ALE_is_disabled = true;
    }
 
 
    void enable_ALE()
    {
      ALE_is_disabled = false;
    }
 
 
    void output(std::ostream& outfile)
    {
      unsigned nplot = 5;
      output(outfile, nplot);
    }
 
    void output(std::ostream& outfile, const unsigned& nplot);
 
 
    void output(FILE* file_pt)
    {
      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& nplot,
                    FiniteElement::SteadyExactSolutionFctPt exact_soln_pt);
 
    virtual void output_fct(
      std::ostream& outfile,
      const unsigned& nplot,
      const double& time,
      FiniteElement::UnsteadyExactSolutionFctPt exact_soln_pt)
    {
      throw OomphLibError("There is no time-dependent output_fct() for "
                          "Advection Diffusion elements",
                          OOMPH_CURRENT_FUNCTION,
                          OOMPH_EXCEPTION_LOCATION);
    }
 
 
    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(
        "No time-dependent compute_error() for Advection Diffusion elements",
        OOMPH_CURRENT_FUNCTION,
        OOMPH_EXCEPTION_LOCATION);
    }
 
    double integrate_u();
 
 
    GeneralisedAdvectionDiffusionSourceFctPt& source_fct_pt()
    {
      return Source_fct_pt;
    }
 
 
    GeneralisedAdvectionDiffusionSourceFctPt source_fct_pt() const
    {
      return Source_fct_pt;
    }
 
 
    GeneralisedAdvectionDiffusionWindFctPt& wind_fct_pt()
    {
      return Wind_fct_pt;
    }
 
 
    GeneralisedAdvectionDiffusionWindFctPt wind_fct_pt() const
    {
      return Wind_fct_pt;
    }
 
 
    GeneralisedAdvectionDiffusionWindFctPt& conserved_wind_fct_pt()
    {
      return Conserved_wind_fct_pt;
    }
 
 
    GeneralisedAdvectionDiffusionWindFctPt conserved_wind_fct_pt() const
    {
      return Conserved_wind_fct_pt;
    }
 
    GeneralisedAdvectionDiffusionDiffFctPt& diff_fct_pt()
    {
      return Diff_fct_pt;
    }
 
    GeneralisedAdvectionDiffusionDiffFctPt diff_fct_pt() const
    {
      return Diff_fct_pt;
    }
 
    const double& pe() const
    {
      return *Pe_pt;
    }
 
    double*& pe_pt()
    {
      return Pe_pt;
    }
 
    const double& pe_st() const
    {
      return *PeSt_pt;
    }
 
    double*& pe_st_pt()
    {
      return PeSt_pt;
    }
 
    inline virtual void get_source_cons_adv_diff(const unsigned& ipt,
                                                 const Vector<double>& x,
                                                 double& source) const
    {
      // If no source function has been set, return zero
      if (Source_fct_pt == 0)
      {
        source = 0.0;
      }
      else
      {
        // Get source strength
        (*Source_fct_pt)(x, source);
      }
    }
 
    inline virtual void get_wind_cons_adv_diff(const unsigned& ipt,
                                               const Vector<double>& s,
                                               const Vector<double>& x,
                                               Vector<double>& wind) const
    {
      // If no wind function has been set, return zero
      if (Wind_fct_pt == 0)
      {
        for (unsigned i = 0; i < DIM; i++)
        {
          wind[i] = 0.0;
        }
      }
      else
      {
        // Get wind
        (*Wind_fct_pt)(x, wind);
      }
    }
 
 
    inline virtual void get_conserved_wind_cons_adv_diff(
      const unsigned& ipt,
      const Vector<double>& s,
      const Vector<double>& x,
      Vector<double>& wind) const
    {
      // If no wind function has been set, return zero
      if (Conserved_wind_fct_pt == 0)
      {
        for (unsigned i = 0; i < DIM; i++)
        {
          wind[i] = 0.0;
        }
      }
      else
      {
        // Get wind
        (*Conserved_wind_fct_pt)(x, wind);
      }
    }
 
 
    inline virtual void get_diff_cons_adv_diff(const unsigned& ipt,
                                               const Vector<double>& s,
                                               const Vector<double>& x,
                                               DenseMatrix<double>& D) const
    {
      // If no wind function has been set, return identity
      if (Diff_fct_pt == 0)
      {
        for (unsigned i = 0; i < DIM; i++)
        {
          for (unsigned j = 0; j < DIM; j++)
          {
            if (i == j)
            {
              D(i, j) = 1.0;
            }
            else
            {
              D(i, j) = 0.0;
            }
          }
        }
      }
      else
      {
        // Get diffusivity tensor
        (*Diff_fct_pt)(x, D);
      }
    }
 
 
    void get_flux(const Vector<double>& s, Vector<double>& flux) const
    {
      // Find out how many nodes there are in the element
      unsigned n_node = nnode();
 
      // Get the nodal index at which the unknown is stored
      unsigned u_nodal_index = u_index_cons_adv_diff();
 
      // 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
      for (unsigned j = 0; j < DIM; j++)
      {
        flux[j] = 0.0;
      }
 
      // Loop over nodes
      for (unsigned l = 0; l < n_node; l++)
      {
        // Loop over derivative directions
        for (unsigned j = 0; j < DIM; j++)
        {
          flux[j] += nodal_value(l, u_nodal_index) * dpsidx(l, j);
        }
      }
    }
 
    void get_total_flux(const Vector<double>& s,
                        Vector<double>& total_flux) const
    {
      // Find out how many nodes there are in the element
      const unsigned n_node = nnode();
 
      // Get the nodal index at which the unknown is stored
      const unsigned u_nodal_index = u_index_cons_adv_diff();
 
      // 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);
 
      // Storage for the Eulerian position
      Vector<double> interpolated_x(DIM, 0.0);
      // Storage for the concentration
      double interpolated_u = 0.0;
      // Storage for the derivatives of the concentration
      Vector<double> interpolated_dudx(DIM, 0.0);
 
      // Loop over nodes
      for (unsigned l = 0; l < n_node; l++)
      {
        // Get the value at the node
        const double u_value = this->nodal_value(l, u_nodal_index);
        interpolated_u += u_value * psi(l);
        // Loop over directions
        for (unsigned j = 0; j < DIM; j++)
        {
          interpolated_x[j] += this->nodal_position(l, j) * psi(l);
          interpolated_dudx[j] += u_value * dpsidx(l, j);
        }
      }
 
      // Dummy integration point
      unsigned ipt = 0;
 
      // Get the conserved wind (non-divergence free)
      Vector<double> conserved_wind(DIM);
      get_conserved_wind_cons_adv_diff(ipt, s, interpolated_x, conserved_wind);
 
      // Get diffusivity tensor
      DenseMatrix<double> D(DIM, DIM);
      get_diff_cons_adv_diff(ipt, s, interpolated_x, D);
 
      // Calculate the total flux made up of the diffusive flux
      // and the conserved wind
      for (unsigned i = 0; i < DIM; i++)
      {
        total_flux[i] = 0.0;
        for (unsigned j = 0; j < DIM; j++)
        {
          total_flux[i] += D(i, j) * interpolated_dudx[j];
        }
        total_flux[i] -= conserved_wind[i] * interpolated_u;
      }
    }
 
 
    void fill_in_contribution_to_residuals(Vector<double>& residuals)
    {
      // Call the generic residuals function with flag set to 0 and using
      // a dummy matrix
      fill_in_generic_residual_contribution_cons_adv_diff(
        residuals,
        GeneralisedElement::Dummy_matrix,
        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_cons_adv_diff(
        residuals, jacobian, GeneralisedElement::Dummy_matrix, 1);
    }
 
 
    void fill_in_contribution_to_jacobian_and_mass_matrix(
      Vector<double>& residuals,
      DenseMatrix<double>& jacobian,
      DenseMatrix<double>& mass_matrix)
    {
      // Call the generic routine with the flag set to 2
      fill_in_generic_residual_contribution_cons_adv_diff(
        residuals, jacobian, mass_matrix, 2);
    }
 
 
    inline double interpolated_u_cons_adv_diff(const Vector<double>& s) const
    {
      // Find number of nodes
      unsigned n_node = nnode();
 
      // Get the nodal index at which the unknown is stored
      unsigned u_nodal_index = u_index_cons_adv_diff();
 
      // Local shape function
      Shape psi(n_node);
 
      // Find values of shape function
      shape(s, psi);
 
      // Initialise value of u
      double interpolated_u = 0.0;
 
      // Loop over the local nodes and sum
      for (unsigned l = 0; l < n_node; l++)
      {
        interpolated_u += nodal_value(l, u_nodal_index) * psi[l];
      }
 
      return (interpolated_u);
    }
 
 
    unsigned self_test();
 
  protected:
    virtual double dshape_and_dtest_eulerian_cons_adv_diff(
      const Vector<double>& s,
      Shape& psi,
      DShape& dpsidx,
      Shape& test,
      DShape& dtestdx) const = 0;
 
    virtual double dshape_and_dtest_eulerian_at_knot_cons_adv_diff(
      const unsigned& ipt,
      Shape& psi,
      DShape& dpsidx,
      Shape& test,
      DShape& dtestdx) const = 0;
 
    virtual void fill_in_generic_residual_contribution_cons_adv_diff(
      Vector<double>& residuals,
      DenseMatrix<double>& jacobian,
      DenseMatrix<double>& mass_matrix,
      unsigned flag);
 
    double* Pe_pt;
 
    double* PeSt_pt;
 
    GeneralisedAdvectionDiffusionSourceFctPt Source_fct_pt;
 
    GeneralisedAdvectionDiffusionWindFctPt Wind_fct_pt;
 
    GeneralisedAdvectionDiffusionWindFctPt Conserved_wind_fct_pt;
 
    GeneralisedAdvectionDiffusionDiffFctPt Diff_fct_pt;
 
    bool ALE_is_disabled;
 
  private:
    static double Default_peclet_number;
  };
 
 
 
 
  //======================================================================
  //======================================================================
  template<unsigned DIM, unsigned NNODE_1D>
  class QGeneralisedAdvectionDiffusionElement
    : public virtual QElement<DIM, NNODE_1D>,
      public virtual GeneralisedAdvectionDiffusionEquations<DIM>
  {
  private:
    static const unsigned Initial_Nvalue;
 
  public:
    QGeneralisedAdvectionDiffusionElement()
      : QElement<DIM, NNODE_1D>(), GeneralisedAdvectionDiffusionEquations<DIM>()
    {
    }
 
    QGeneralisedAdvectionDiffusionElement(
      const QGeneralisedAdvectionDiffusionElement<DIM, NNODE_1D>& dummy) =
      delete;
 
    void operator=(
      const QGeneralisedAdvectionDiffusionElement<DIM, NNODE_1D>&) = delete;
 
    inline unsigned required_nvalue(const unsigned& n) const
    {
      return Initial_Nvalue;
    }
 
    void output(std::ostream& outfile)
    {
      GeneralisedAdvectionDiffusionEquations<DIM>::output(outfile);
    }
 
    void output(std::ostream& outfile, const unsigned& n_plot)
    {
      GeneralisedAdvectionDiffusionEquations<DIM>::output(outfile, n_plot);
    }
 
 
    void output(FILE* file_pt)
    {
      GeneralisedAdvectionDiffusionEquations<DIM>::output(file_pt);
    }
 
    void output(FILE* file_pt, const unsigned& n_plot)
    {
      GeneralisedAdvectionDiffusionEquations<DIM>::output(file_pt, n_plot);
    }
 
    void output_fct(std::ostream& outfile,
                    const unsigned& n_plot,
                    FiniteElement::SteadyExactSolutionFctPt exact_soln_pt)
    {
      GeneralisedAdvectionDiffusionEquations<DIM>::output_fct(
        outfile, n_plot, exact_soln_pt);
    }
 
 
    void output_fct(std::ostream& outfile,
                    const unsigned& n_plot,
                    const double& time,
                    FiniteElement::UnsteadyExactSolutionFctPt exact_soln_pt)
    {
      GeneralisedAdvectionDiffusionEquations<DIM>::output_fct(
        outfile, n_plot, time, exact_soln_pt);
    }
 
 
  protected:
    inline double dshape_and_dtest_eulerian_cons_adv_diff(
      const Vector<double>& s,
      Shape& psi,
      DShape& dpsidx,
      Shape& test,
      DShape& dtestdx) const;
 
    inline double dshape_and_dtest_eulerian_at_knot_cons_adv_diff(
      const unsigned& ipt,
      Shape& psi,
      DShape& dpsidx,
      Shape& test,
      DShape& dtestdx) const;
  };
 
  // Inline functions:
 
 
  //======================================================================
  //======================================================================
  template<unsigned DIM, unsigned NNODE_1D>
  double QGeneralisedAdvectionDiffusionElement<DIM, NNODE_1D>::
    dshape_and_dtest_eulerian_cons_adv_diff(const Vector<double>& s,
                                            Shape& psi,
                                            DShape& dpsidx,
                                            Shape& test,
                                            DShape& dtestdx) const
  {
    // Call the geometrical shape functions and derivatives
    double J = this->dshape_eulerian(s, psi, dpsidx);
 
    // Loop over the test functions and derivatives and set them equal to the
    // shape functions
    for (unsigned i = 0; i < NNODE_1D; i++)
    {
      test[i] = psi[i];
      for (unsigned j = 0; j < DIM; j++)
      {
        dtestdx(i, j) = dpsidx(i, j);
      }
    }
 
    // Return the jacobian
    return J;
  }
 
 
  //======================================================================
  //======================================================================
  template<unsigned DIM, unsigned NNODE_1D>
  double QGeneralisedAdvectionDiffusionElement<DIM, NNODE_1D>::
    dshape_and_dtest_eulerian_at_knot_cons_adv_diff(const unsigned& ipt,
                                                    Shape& psi,
                                                    DShape& dpsidx,
                                                    Shape& test,
                                                    DShape& dtestdx) const
  {
    // Call the geometrical shape functions and derivatives
    double J = this->dshape_eulerian_at_knot(ipt, psi, dpsidx);
 
    // Set the test functions equal to the shape functions (pointer copy)
    test = psi;
    dtestdx = dpsidx;
 
    // Return the jacobian
    return J;
  }
 
 
 
 
  //=======================================================================
  //=======================================================================
  template<unsigned DIM, unsigned NNODE_1D>
  class FaceGeometry<QGeneralisedAdvectionDiffusionElement<DIM, NNODE_1D>>
    : public virtual QElement<DIM - 1, NNODE_1D>
  {
  public:
    FaceGeometry() : QElement<DIM - 1, NNODE_1D>() {}
  };
 
 
 
 
  //=======================================================================
  //=======================================================================
  template<unsigned NNODE_1D>
  class FaceGeometry<QGeneralisedAdvectionDiffusionElement<1, NNODE_1D>>
    : public virtual PointElement
  {
  public:
    FaceGeometry() : PointElement() {}
  };
 
} // namespace oomph
 
#endif