unsteady_heat_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 UnsteadyHeat elements
#ifndef OOMPH_UNSTEADY_HEAT_ELEMENTS_HEADER
#define OOMPH_UNSTEADY_HEAT_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"
 
 
namespace oomph
{
  class UnsteadyHeatEquationsBase : public virtual FiniteElement
  {
  public:
    typedef void (*UnsteadyHeatSourceFctPt)(const double& time,
                                            const Vector<double>& x,
                                            double& u);
 
    virtual UnsteadyHeatSourceFctPt& source_fct_pt() = 0;
  };
 
  //=============================================================
  //=============================================================
  template<unsigned DIM>
  class UnsteadyHeatEquations : public virtual UnsteadyHeatEquationsBase
  {
  public:
    typedef void (*UnsteadyHeatSourceFctPt)(const double& time,
                                            const Vector<double>& x,
                                            double& u);
 
 
    UnsteadyHeatEquations() : Source_fct_pt(0), ALE_is_disabled(false)
    {
      // Set Alpha and Beta parameter to default (one for natural scaling of
      // time)
      Alpha_pt = &Default_alpha_parameter;
      Beta_pt = &Default_beta_parameter;
    }
 
 
    UnsteadyHeatEquations(const UnsteadyHeatEquations& 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 UnsteadyHeatEquations&) = delete;*/
 
    virtual inline unsigned u_index_ust_heat() const
    {
      return 0;
    }
 
    double du_dt_ust_heat(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_ust_heat();
 
        // Number of timsteps (past & present)
        const unsigned n_time = time_stepper_pt->ntstorage();
 
        // Add the contributions to the time derivative
        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 compute_norm(double& norm);
 
    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);
 
 
    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);
 
 
    UnsteadyHeatSourceFctPt& source_fct_pt()
    {
      return Source_fct_pt;
    }
 
 
    UnsteadyHeatSourceFctPt source_fct_pt() const
    {
      return Source_fct_pt;
    }
 
 
    virtual inline void get_source_ust_heat(const double& t,
                                            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)(t, x, source);
      }
    }
 
    const double& alpha() const
    {
      return *Alpha_pt;
    }
 
    double*& alpha_pt()
    {
      return Alpha_pt;
    }
 
 
    const double& beta() const
    {
      return *Beta_pt;
    }
 
    double*& beta_pt()
    {
      return Beta_pt;
    }
 
    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();
 
      // Find the index at which the variable is stored
      unsigned u_nodal_index = u_index_ust_heat();
 
      // 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 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_ust_heat(
        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_ust_heat(residuals, jacobian, 1);
    }
 
 
    inline double interpolated_u_ust_heat(const Vector<double>& s) const
    {
      // Find number of nodes
      unsigned n_node = nnode();
 
      // Find the index at which the variable is stored
      unsigned u_nodal_index = u_index_ust_heat();
 
      // 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);
    }
 
 
    inline double interpolated_u_ust_heat(const unsigned& t,
                                          const Vector<double>& s) const
    {
      // Find number of nodes
      unsigned n_node = nnode();
 
      // Find the index at which the variable is stored
      unsigned u_nodal_index = u_index_ust_heat();
 
      // 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(t, l, u_nodal_index) * psi[l];
      }
 
      return (interpolated_u);
    }
 
 
    inline double interpolated_du_dt_ust_heat(const Vector<double>& s) const
    {
      // Find number of nodes
      unsigned n_node = nnode();
 
      // Local shape function
      Shape psi(n_node);
 
      // Find values of shape function
      shape(s, psi);
 
      // Initialise value of du/dt
      double interpolated_dudt = 0.0;
 
      // Loop over the local nodes and sum
      for (unsigned l = 0; l < n_node; l++)
      {
        interpolated_dudt += du_dt_ust_heat(l) * psi[l];
      }
 
      return (interpolated_dudt);
    }
 
 
    unsigned self_test();
 
 
  protected:
    virtual double dshape_and_dtest_eulerian_ust_heat(
      const Vector<double>& s,
      Shape& psi,
      DShape& dpsidx,
      Shape& test,
      DShape& dtestdx) const = 0;
 
 
    virtual double dshape_and_dtest_eulerian_at_knot_ust_heat(
      const unsigned& ipt,
      Shape& psi,
      DShape& dpsidx,
      Shape& test,
      DShape& dtestdx) const = 0;
 
    virtual void fill_in_generic_residual_contribution_ust_heat(
      Vector<double>& residuals, DenseMatrix<double>& jacobian, unsigned flag);
 
    UnsteadyHeatSourceFctPt Source_fct_pt;
 
    bool ALE_is_disabled;
 
    double* Alpha_pt;
 
    double* Beta_pt;
 
  private:
    static double Default_alpha_parameter;
 
    static double Default_beta_parameter;
  };
 
 
 
 
  //======================================================================
  //======================================================================
  template<unsigned DIM, unsigned NNODE_1D>
  class QUnsteadyHeatElement : public virtual QElement<DIM, NNODE_1D>,
                               public virtual UnsteadyHeatEquations<DIM>
  {
  private:
    static const unsigned Initial_Nvalue;
 
  public:
    QUnsteadyHeatElement()
      : QElement<DIM, NNODE_1D>(), UnsteadyHeatEquations<DIM>()
    {
    }
 
    QUnsteadyHeatElement(const QUnsteadyHeatElement<DIM, NNODE_1D>& dummy) =
      delete;
 
    /*void operator=(const QUnsteadyHeatElement<DIM,NNODE_1D>&) = delete;*/
 
    inline unsigned required_nvalue(const unsigned& n) const
    {
      return Initial_Nvalue;
    }
 
    void output(std::ostream& outfile)
    {
      UnsteadyHeatEquations<DIM>::output(outfile);
    }
 
 
    void output(std::ostream& outfile, const unsigned& n_plot)
    {
      UnsteadyHeatEquations<DIM>::output(outfile, n_plot);
    }
 
 
    void output(FILE* file_pt)
    {
      UnsteadyHeatEquations<DIM>::output(file_pt);
    }
 
 
    void output(FILE* file_pt, const unsigned& n_plot)
    {
      UnsteadyHeatEquations<DIM>::output(file_pt, n_plot);
    }
 
 
    void output_fct(std::ostream& outfile,
                    const unsigned& n_plot,
                    FiniteElement::SteadyExactSolutionFctPt exact_soln_pt)
    {
      UnsteadyHeatEquations<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)
    {
      UnsteadyHeatEquations<DIM>::output_fct(
        outfile, n_plot, time, exact_soln_pt);
    }
 
 
  protected:
    inline double dshape_and_dtest_eulerian_ust_heat(const Vector<double>& s,
                                                     Shape& psi,
                                                     DShape& dpsidx,
                                                     Shape& test,
                                                     DShape& dtestdx) const;
 
 
    inline double dshape_and_dtest_eulerian_at_knot_ust_heat(
      const unsigned& ipt,
      Shape& psi,
      DShape& dpsidx,
      Shape& test,
      DShape& dtestdx) const;
  };
 
 
  // Inline functions:
 
 
  //======================================================================
  //======================================================================
  template<unsigned DIM, unsigned NNODE_1D>
  double QUnsteadyHeatElement<DIM, NNODE_1D>::
    dshape_and_dtest_eulerian_ust_heat(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 QUnsteadyHeatElement<DIM, NNODE_1D>::
    dshape_and_dtest_eulerian_at_knot_ust_heat(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
    //(sets internal pointers)
    test = psi;
    dtestdx = dpsidx;
 
    // Return the jacobian
    return J;
  }
 
 
 
 
  //=======================================================================
  //=======================================================================
  template<unsigned DIM, unsigned NNODE_1D>
  class FaceGeometry<QUnsteadyHeatElement<DIM, NNODE_1D>>
    : public virtual QElement<DIM - 1, NNODE_1D>
  {
  public:
    FaceGeometry() : QElement<DIM - 1, NNODE_1D>() {}
  };
 
 
 
  //=======================================================================
  //=======================================================================
  template<unsigned NNODE_1D>
  class FaceGeometry<QUnsteadyHeatElement<1, NNODE_1D>>
    : public virtual PointElement
  {
  public:
    FaceGeometry() : PointElement() {}
  };
 
 
 
 
  //==========================================================
  //==========================================================
  template<class UNSTEADY_HEAT_ELEMENT>
  class ProjectableUnsteadyHeatElement
    : public virtual ProjectableElement<UNSTEADY_HEAT_ELEMENT>
  {
  public:
    ProjectableUnsteadyHeatElement() {}
 
    Vector<std::pair<Data*, unsigned>> data_values_of_field(const unsigned& fld)
    {
#ifdef PARANOID
      if (fld != 0)
      {
        std::stringstream error_stream;
        error_stream << "UnsteadyHeat elements only store a single field so "
                        "fld must be 0 rather"
                     << " than " << fld << std::endl;
        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 1;
    }
 
    unsigned nhistory_values_for_projection(const unsigned& fld)
    {
#ifdef PARANOID
      if (fld != 0)
      {
        std::stringstream error_stream;
        error_stream << "UnsteadyHeat elements only store a single field so "
                        "fld must be 0 rather"
                     << " than " << fld << std::endl;
        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 != 0)
      {
        std::stringstream error_stream;
        error_stream << "UnsteadyHeat elements only store a single field so "
                        "fld must be 0 rather"
                     << " than " << fld << std::endl;
        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_ust_heat(s, psi, dpsidx, test, dtestdx);
      return J;
    }
 
 
    double get_field(const unsigned& t,
                     const unsigned& fld,
                     const Vector<double>& s)
    {
#ifdef PARANOID
      if (fld != 0)
      {
        std::stringstream error_stream;
        error_stream << "UnsteadyHeat elements only store a single field so "
                        "fld must be 0 rather"
                     << " than " << fld << std::endl;
        throw OomphLibError(
          error_stream.str(), OOMPH_CURRENT_FUNCTION, OOMPH_EXCEPTION_LOCATION);
      }
#endif
      // Find the index at which the variable is stored
      unsigned u_nodal_index = this->u_index_ust_heat();
 
      // 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 != 0)
      {
        std::stringstream error_stream;
        error_stream << "UnsteadyHeat elements only store a single field so "
                        "fld must be 0 rather"
                     << " than " << fld << std::endl;
        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 != 0)
      {
        std::stringstream error_stream;
        error_stream << "UnsteadyHeat elements only store a single field so "
                        "fld must be 0 rather"
                     << " than " << fld << std::endl;
        throw OomphLibError(
          error_stream.str(), OOMPH_CURRENT_FUNCTION, OOMPH_EXCEPTION_LOCATION);
      }
#endif
      const unsigned u_nodal_index = this->u_index_ust_heat();
      return this->nodal_local_eqn(j, u_nodal_index);
    }
 
 
    void output(std::ostream& outfile, const unsigned& nplot)
    {
      unsigned el_dim = this->dim();
      // Vector of local coordinates
      Vector<double> s(el_dim);
 
      // Tecplot header info
      outfile << this->tecplot_zone_string(nplot);
 
      // Loop over plot points
      unsigned num_plot_points = this->nplot_points(nplot);
      for (unsigned iplot = 0; iplot < num_plot_points; iplot++)
      {
        // Get local coordinates of plot point
        this->get_s_plot(iplot, nplot, s);
 
        for (unsigned i = 0; i < el_dim; i++)
        {
          outfile << this->interpolated_x(s, i) << " ";
        }
        outfile << this->interpolated_u_ust_heat(s) << " ";
        outfile << this->interpolated_du_dt_ust_heat(s) << " ";
 
 
        // History values of coordinates
        unsigned n_prev =
          this->node_pt(0)->position_time_stepper_pt()->ntstorage();
        for (unsigned t = 1; t < n_prev; t++)
        {
          for (unsigned i = 0; i < el_dim; i++)
          {
            outfile << this->interpolated_x(t, s, i) << " ";
          }
        }
 
        // History values of velocities
        n_prev = this->node_pt(0)->time_stepper_pt()->ntstorage();
        for (unsigned t = 1; t < n_prev; t++)
        {
          outfile << this->interpolated_u_ust_heat(t, s) << " ";
        }
        outfile << std::endl;
      }
 
 
      // Write tecplot footer (e.g. FE connectivity lists)
      this->write_tecplot_zone_footer(outfile, nplot);
    }
  };
 
 
  //=======================================================================
  //=======================================================================
  template<class ELEMENT>
  class FaceGeometry<ProjectableUnsteadyHeatElement<ELEMENT>>
    : public virtual FaceGeometry<ELEMENT>
  {
  public:
    FaceGeometry() : FaceGeometry<ELEMENT>() {}
  };
 
 
  //=======================================================================
  //=======================================================================
  template<class ELEMENT>
  class FaceGeometry<FaceGeometry<ProjectableUnsteadyHeatElement<ELEMENT>>>
    : public virtual FaceGeometry<FaceGeometry<ELEMENT>>
  {
  public:
    FaceGeometry() : FaceGeometry<FaceGeometry<ELEMENT>>() {}
  };
 
 
} // namespace oomph
 
#endif