Base class for elements with pml capabilities. More...

#include <pml_meshes.h>

Inheritance diagram for oomph::PMLElementBase< DIM >:

Public Member Functions
	PMLElementBase ()
	Constructor. More...

virtual	~PMLElementBase ()
	Virtual destructor. More...

void	disable_pml ()

void	enable_pml (const int &direction, const double &interface_border_value, const double &outer_domain_border_value)

virtual void	values_to_be_pinned_on_outer_pml_boundary (Vector< unsigned > &values_to_pin)=0

Protected Attributes
bool	Pml_is_enabled
	Boolean indicating if element is used in pml mode. More...

std::vector< bool >	Pml_direction_active

Vector< double >	Pml_inner_boundary

Vector< double >	Pml_outer_boundary

Detailed Description

template<unsigned DIM>
class oomph::PMLElementBase< DIM >

Base class for elements with pml capabilities.

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

Constructor & Destructor Documentation

◆ PMLElementBase()

template<unsigned DIM>

oomph::PMLElementBase< DIM >::PMLElementBase ( )

inline

Constructor.

       : Pml_is_enabled(false),
         Pml_direction_active(DIM, false),
         Pml_inner_boundary(DIM, 0.0),
         Pml_outer_boundary(DIM, 0.0)
     {
     }

◆ ~PMLElementBase()

template<unsigned DIM>

virtual oomph::PMLElementBase< DIM >::~PMLElementBase ( )

inlinevirtual

Virtual destructor.

72 {}

Member Function Documentation

◆ disable_pml()

template<unsigned DIM>

void oomph::PMLElementBase< DIM >::disable_pml ( )

inline

Disable pml. Ensures the PML-ification in all directions has been deactivated

     {
       // Disable the PML-ification
       Pml_is_enabled = false;
  
       // Loop over the entries in Pml_direction_active and deactivate the
       // PML in this direction
       for (unsigned direction = 0; direction < DIM; direction++)
       {
         // Disable the PML in this direction
         Pml_direction_active[direction] = false;
       }
     } // End of disable_pml

References DIM, oomph::PMLElementBase< DIM >::Pml_direction_active, and oomph::PMLElementBase< DIM >::Pml_is_enabled.

◆ enable_pml()

template<unsigned DIM>

void oomph::PMLElementBase< DIM >::enable_pml	(	const int &	direction,
		const double &	interface_border_value,
		const double &	outer_domain_border_value
	)

inline

Enable pml. Specify the coordinate direction along which pml boundary is constant, as well as the coordinate along the dimension for the interface between the physical and artificial domains and the coordinate for the outer boundary. All of these are used to adjust the perfectly matched layer mechanism. Needs to be called separately for each pml-ified direction (if needed – e.g. in corner elements)

     {
       Pml_is_enabled = true;
       Pml_direction_active[direction] = true;
       Pml_inner_boundary[direction] = interface_border_value;
       Pml_outer_boundary[direction] = outer_domain_border_value;
     }

References oomph::PMLElementBase< DIM >::Pml_direction_active, oomph::PMLElementBase< DIM >::Pml_inner_boundary, oomph::PMLElementBase< DIM >::Pml_is_enabled, and oomph::PMLElementBase< DIM >::Pml_outer_boundary.

Referenced by oomph::TwoDimensionalPMLHelper::create_bottom_left_pml_mesh(), oomph::TwoDimensionalPMLHelper::create_bottom_pml_mesh(), oomph::TwoDimensionalPMLHelper::create_bottom_right_pml_mesh(), oomph::TwoDimensionalPMLHelper::create_left_pml_mesh(), oomph::TwoDimensionalPMLHelper::create_right_pml_mesh(), oomph::TwoDimensionalPMLHelper::create_top_left_pml_mesh(), oomph::TwoDimensionalPMLHelper::create_top_pml_mesh(), and oomph::TwoDimensionalPMLHelper::create_top_right_pml_mesh().

◆ values_to_be_pinned_on_outer_pml_boundary()

template<unsigned DIM>

virtual void oomph::PMLElementBase< DIM >::values_to_be_pinned_on_outer_pml_boundary ( Vector< unsigned > & values_to_pin )

pure virtual

Pure virtual function in which we have to specify the values to be pinned (and set to zero) on the outer edge of the pml layer. This is usually all of the nodal values (values 0 and 1 (real and imag part) for Helmholtz; values 0,1,2 and 3 (real and imag part of x- and y-displacement for 2D time-harmonic linear elasticity; etc.). Vector must be resized internally!

Implemented in oomph::PMLTimeHarmonicLinearElasticityEquationsBase< DIM >, oomph::PMLHelmholtzEquations< DIM >, oomph::PMLFourierDecomposedHelmholtzEquations, oomph::MyRefineableQTaylorHoodElement, and oomph::MyRefineableQTaylorHoodElement.

Referenced by oomph::TwoDimensionalPMLHelper::create_bottom_left_pml_mesh(), oomph::TwoDimensionalPMLHelper::create_bottom_pml_mesh(), oomph::TwoDimensionalPMLHelper::create_bottom_right_pml_mesh(), oomph::TwoDimensionalPMLHelper::create_left_pml_mesh(), oomph::TwoDimensionalPMLHelper::create_right_pml_mesh(), oomph::TwoDimensionalPMLHelper::create_top_left_pml_mesh(), oomph::TwoDimensionalPMLHelper::create_top_pml_mesh(), and oomph::TwoDimensionalPMLHelper::create_top_right_pml_mesh().