refineable_pml_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//    Version 1.0; svn revision $LastChangedRevision$
//LIC//
//LIC// $LastChangedDate$
//LIC// 
//LIC// Copyright (C) 2006-2016 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 QPMLHelmholtzElement elements

#ifndef OOMPH_REFINEABLE_PML_HELMHOLTZ_ELEMENTS_HEADER
#define OOMPH_REFINEABLE_PML_HELMHOLTZ_ELEMENTS_HEADER

// Config header generated by autoconfig
#ifdef HAVE_CONFIG_H
  #include <oomph-lib-config.h>
#endif


//oomph-lib headers
#include "../generic/refineable_quad_element.h"
#include "../generic/refineable_brick_element.h"
#include "../generic/hp_refineable_elements.h"
#include "../generic/error_estimator.h"
#include "pml_helmholtz_elements.h"

namespace oomph
{

///////////////////////////////////////////////////////////////////////////
///////////////////////////////////////////////////////////////////////////



//======================================================================
/// Refineable version of PMLHelmholtz equations
///
///
//======================================================================
template <unsigned DIM, class PML_ELEMENT>
class RefineablePMLHelmholtzEquations : 
 public virtual PMLHelmholtzEquations<DIM,PML_ELEMENT>,
 public virtual RefineableElement,
 public virtual ElementWithZ2ErrorEstimator
 {
  public:

 /// \short Constructor, simply call other constructors
 RefineablePMLHelmholtzEquations() : PMLHelmholtzEquations<DIM,PML_ELEMENT>(),
  RefineableElement(), ElementWithZ2ErrorEstimator() 
  { } 

 /// Broken copy constructor
 RefineablePMLHelmholtzEquations(const RefineablePMLHelmholtzEquations<DIM,PML_ELEMENT>& dummy) 
  { 
   BrokenCopy::broken_copy("RefineablePMLHelmholtzEquations");
  } 
 
 /// Broken assignment operator
//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 RefineablePMLHelmholtzEquations<DIM>&) 
  {
   BrokenCopy::broken_assign("RefineablePMLHelmholtzEquations");
   }*/
 
 /// Number of 'flux' terms for Z2 error estimation 
 unsigned num_Z2_flux_terms() {return 2*DIM;}

 /// \short Get 'flux' for Z2 error recovery:  Complex flux from 
 /// PMLHelmholtz equations, strung together
 void get_Z2_flux(const Vector<double>& s, Vector<double>& flux)
  {
   Vector<std::complex <double> > complex_flux(DIM);
   this->get_flux(s,complex_flux);
   unsigned count=0;
   for (unsigned i=0;i<DIM;i++)
    {
     flux[count]=complex_flux[i].real();
     count++;
     flux[count]=complex_flux[i].imag();
     count++;
    }
  }

 
/// \short Get the function value u in Vector.
/// Note: Given the generality of the interface (this function
/// is usually called from black-box documentation or interpolation routines),
/// the values Vector sets its own size in here.
void get_interpolated_values(const Vector<double>&s,  Vector<double>& values)
 {
  // Set size of Vector: u
  values.resize(2);
  
  //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 u
  values[0] = 0.0;
  values[1] = 0.0;

  //Find the index at which the pml_helmholtz unknown is stored
  std::complex<unsigned> u_nodal_index = this->u_index_helmholtz();
  
  //Loop over the local nodes and sum up the values
  for(unsigned l=0;l<n_node;l++)
   {
    values[0] += this->nodal_value(l,u_nodal_index.real())*psi[l];
    values[1] += this->nodal_value(l,u_nodal_index.imag())*psi[l];
   }
 }


 /// \short Get the function value u in Vector.
 /// Note: Given the generality of the interface (this function
 /// is usually called from black-box documentation or interpolation routines),
 /// the values Vector sets its own size in here.
 void get_interpolated_values(const unsigned& t, const Vector<double>&s, 
                              Vector<double>& values)
  {
   if (t!=0)
    {
     std::string error_message =
      "Time-dependent version of get_interpolated_values() ";
     error_message += "not implemented for this element \n";
     throw 
      OomphLibError(error_message,
                    "RefineablePMLHelmholtzEquations::get_interpolated_values()",
                    OOMPH_EXCEPTION_LOCATION);
    }
   else
    {
     //Make sure that we call this particular object's steady 
     //get_interpolated_values (it could get overloaded lower down)
     RefineablePMLHelmholtzEquations<DIM,PML_ELEMENT>::get_interpolated_values(s,values);
    }
  }

 
 ///  Further build: Copy source function pointer from father element
 void further_build()
  {
   this->Source_fct_pt=dynamic_cast<RefineablePMLHelmholtzEquations<DIM,PML_ELEMENT>*>(
    this->father_element_pt())->source_fct_pt();
  }


  private:


/// \short Add element's contribution to elemental residual vector and/or
/// Jacobian matrix
/// flag=1: compute both
/// flag=0: compute only residual vector
 void fill_in_generic_residual_contribution_helmholtz(
  Vector<double> &residuals, DenseMatrix<double> &jacobian,
  const unsigned& flag);
  
};


//======================================================================
/// Refineable version of QPMLHelmholtzElement elements
///
///
//======================================================================
template <unsigned DIM, unsigned NNODE_1D, class PML_ELEMENT>
 class RefineableQPMLHelmholtzElement : 
 public QPMLHelmholtzElement<DIM,NNODE_1D,PML_ELEMENT>,
 public virtual RefineablePMLHelmholtzEquations<DIM,PML_ELEMENT>,
 public virtual RefineableQElement<DIM>
{
  public:

 /// \short Constructor, simply call the other constructors 
 RefineableQPMLHelmholtzElement() : 
  RefineableElement(),
  RefineablePMLHelmholtzEquations<DIM,PML_ELEMENT>(),
  RefineableQElement<DIM>(),
  QPMLHelmholtzElement<DIM,NNODE_1D,PML_ELEMENT>()
   {} 


 /// Broken copy constructor
 RefineableQPMLHelmholtzElement(const RefineableQPMLHelmholtzElement<DIM,NNODE_1D,PML_ELEMENT>& 
                           dummy) 
  { 
   BrokenCopy::broken_copy("RefineableQuadPMLHelmholtzElement");
  } 
 
 /// Broken assignment operator
 /*void operator=(const RefineableQPMLHelmholtzElement<DIM,NNODE_1D>&) 
  {
   BrokenCopy::broken_assign("RefineableQuadPMLHelmholtzElement");
   }*/
 
 /// Number of continuously interpolated values: 2
 unsigned ncont_interpolated_values() const {return 2;}

 /// \short Number of vertex nodes in the element
 unsigned nvertex_node() const
  {return QPMLHelmholtzElement<DIM,NNODE_1D,PML_ELEMENT>::nvertex_node();}

 /// \short Pointer to the j-th vertex node in the element
 Node* vertex_node_pt(const unsigned& j) const
  {return QPMLHelmholtzElement<DIM,NNODE_1D,PML_ELEMENT>::vertex_node_pt(j);}

 /// Rebuild from sons: empty
 void rebuild_from_sons(Mesh* &mesh_pt) {}

 /// \short Order of recovery shape functions for Z2 error estimation:
 /// Same order as shape functions.
 unsigned nrecovery_order() {return (NNODE_1D-1);}

 ///  \short Perform additional hanging node procedures for variables
 /// that are not interpolated by all nodes. Empty.
 void further_setup_hanging_nodes(){}

};



////////////////////////////////////////////////////////////////////////
////////////////////////////////////////////////////////////////////////
////////////////////////////////////////////////////////////////////////



//=======================================================================
/// Face geometry for the RefineableQuadPMLHelmholtzElement elements: 
/// The spatial 
/// dimension of the face elements is one lower than that of the
/// bulk element but they have the same number of points
/// along their 1D edges.
//=======================================================================
template<unsigned DIM, unsigned NNODE_1D, class PML_ELEMENT>
class FaceGeometry<RefineableQPMLHelmholtzElement<DIM,NNODE_1D,PML_ELEMENT> >: 
 public virtual QElement<DIM-1,NNODE_1D>
{

  public:
 
 /// \short Constructor: Call the constructor for the
 /// appropriate lower-dimensional QElement
 FaceGeometry() : QElement<DIM-1,NNODE_1D>() {}

};

//=======================================================================
/// Policy class defining the elements to be used in the actual
/// PML layers. Same!
//=======================================================================
template<unsigned NNODE_1D, class PML_ELEMENT>
 class EquivalentQElement<RefineableQPMLHelmholtzElement<2,NNODE_1D,PML_ELEMENT> > :
 public virtual RefineableQPMLHelmholtzElement<2,NNODE_1D,PML_ELEMENT>
 {
  
   public:
  
  /// \short Constructor: Call the constructor for the
  /// appropriate QElement
   EquivalentQElement() :
  RefineableQPMLHelmholtzElement<2,NNODE_1D,PML_ELEMENT>()
   {}
  
 };

}

#endif