oomph::SamplePointContainerParameters Class Reference

#include <sample_point_parameters.h>

Inheritance diagram for oomph::SamplePointContainerParameters:

Public Member Functions
	SamplePointContainerParameters (const SamplePointContainerParameters &data)=delete
	Broken copy constructor. More...
void	operator= (const SamplePointContainerParameters &)=delete
	Broken assignment operator. More...
virtual	~SamplePointContainerParameters ()
	Empty destructor. More...
Mesh *	mesh_pt () const
	Pointer to mesh from whose FiniteElements sample points are created. More...
Vector< std::pair< double, double > > &	min_and_max_coordinates ()
Vector< std::pair< double, double > >	min_and_max_coordinates () const
unsigned	nsample_points_generated_per_element () const
unsigned &	nsample_points_generated_per_element ()
	"Measure of" number of sample points generated in each element More...
bool	use_eulerian_coordinates_during_setup () const
void	enable_use_eulerian_coordinates_during_setup ()
void	disable_use_eulerian_coordinates_during_setup ()
bool	ignore_halo_elements_during_locate_zeta_search () const
	Ignore halo elements? (MPI only) More...
void	enable_ignore_halo_elements_during_locate_zeta_search ()
	Enable Ignore halo elements? (MPI only) More...
void	disable_ignore_halo_elements_during_locate_zeta_search ()
	Disable Ignore halo elements? (MPI only) More...

Static Public Attributes
static unsigned	Default_nsample_points_generated_per_element
	Default for "measure of" number of sample points per element. More...

Protected Attributes
Mesh *	Mesh_pt
	Pointer to mesh from whose FiniteElements sample points are created. More...
Vector< std::pair< double, double > >	Min_and_max_coordinates
unsigned	Nsample_points_generated_per_element
	"Measure of" number of sample points generated in each element More...
bool	Use_eulerian_coordinates_during_setup
bool	Ignore_halo_elements_during_locate_zeta_search

Private Member Functions
	SamplePointContainerParameters (Mesh *mesh_pt)
	SamplePointContainerParameters ()

Friends
class	BinArrayParameters
class	RefineableBinArrayParameters
class	NonRefineableBinArrayParameters

Detailed Description

///////////////////////////////////////////////////////////////// ///////////////////////////////////////////////////////////////// ///////////////////////////////////////////////////////////////// Helper object for dealing with the parameters used for the SamplePointContainer objects

Constructor & Destructor Documentation

SamplePointContainerParameters() [1/3]

oomph::SamplePointContainerParameters::SamplePointContainerParameters ( const SamplePointContainerParameters &  data )

delete

Broken copy constructor.

~SamplePointContainerParameters()

virtual oomph::SamplePointContainerParameters::~SamplePointContainerParameters ( )

inlinevirtual

Empty destructor.

{}

SamplePointContainerParameters() [2/3]

oomph::SamplePointContainerParameters::SamplePointContainerParameters ( Mesh *  mesh_pt )

inlineprivate

Constructor: Pass mesh. Constructor is private and can only be called by the derived friends.

      : Mesh_pt(mesh_pt),
        Nsample_points_generated_per_element(
          Default_nsample_points_generated_per_element),
        Use_eulerian_coordinates_during_setup(false),
        Ignore_halo_elements_during_locate_zeta_search(false)
    {
    }

SamplePointContainerParameters() [3/3]

oomph::SamplePointContainerParameters::SamplePointContainerParameters ( )

inlineprivate

Broken default constructor; needed for broken copy constructors. Don't call. It will die.

    {
      // Throw the error
      throw OomphLibError("Broken default constructor. Don't call this!",
                          OOMPH_CURRENT_FUNCTION,
                          OOMPH_EXCEPTION_LOCATION);
    }

References OOMPH_CURRENT_FUNCTION, and OOMPH_EXCEPTION_LOCATION.

Member Function Documentation

disable_ignore_halo_elements_during_locate_zeta_search()

void oomph::SamplePointContainerParameters::disable_ignore_halo_elements_during_locate_zeta_search ( )

inline

Disable Ignore halo elements? (MPI only)

    {
      Ignore_halo_elements_during_locate_zeta_search = false;
    }

References Ignore_halo_elements_during_locate_zeta_search.

disable_use_eulerian_coordinates_during_setup()

void oomph::SamplePointContainerParameters::disable_use_eulerian_coordinates_during_setup ( )

inline

Disable use of eulerian coordinates (via interpolated_x) during setup (otherwise use interpolated_zeta())

    {
      Use_eulerian_coordinates_during_setup = false;
    }

References Use_eulerian_coordinates_during_setup.

enable_ignore_halo_elements_during_locate_zeta_search()

void oomph::SamplePointContainerParameters::enable_ignore_halo_elements_during_locate_zeta_search ( )

inline

Enable Ignore halo elements? (MPI only)

    {
      Ignore_halo_elements_during_locate_zeta_search = true;
    }

References Ignore_halo_elements_during_locate_zeta_search.

enable_use_eulerian_coordinates_during_setup()

void oomph::SamplePointContainerParameters::enable_use_eulerian_coordinates_during_setup ( )

inline

Enable use of eulerian coordinates (via interpolated_x) during setup (otherwise use interpolated_zeta())

    {
      Use_eulerian_coordinates_during_setup = true;
    }

References Use_eulerian_coordinates_during_setup.

ignore_halo_elements_during_locate_zeta_search()

bool oomph::SamplePointContainerParameters::ignore_halo_elements_during_locate_zeta_search ( ) const

inline

Ignore halo elements? (MPI only)

    {
      return Ignore_halo_elements_during_locate_zeta_search;
    }

References Ignore_halo_elements_during_locate_zeta_search.

mesh_pt()

Mesh* oomph::SamplePointContainerParameters::mesh_pt ( ) const

inline

Pointer to mesh from whose FiniteElements sample points are created.

    {
      return Mesh_pt;
    }

References Mesh_pt.

Referenced by oomph::MeshAsGeomObject::build_it().

min_and_max_coordinates() [1/2]

Vector<std::pair<double, double> >& oomph::SamplePointContainerParameters::min_and_max_coordinates ( )

inline

Vector of pairs of doubles for min and maximum coordinates. Call: Min_and_max_coordinates[j] gives me the pair of min (first) and max. (second) coordinates in the j-th coordinate direction.

    {
      return Min_and_max_coordinates;
    }

References Min_and_max_coordinates.

min_and_max_coordinates() [2/2]

Vector<std::pair<double, double> > oomph::SamplePointContainerParameters::min_and_max_coordinates ( ) const

inline

Vector of pairs of doubles for min and maximum coordinates. Call: Min_and_max_coordinates[j] gives me the pair of min (first) and max. (second) coordinates in the j-th coordinate direction. Const version

    {
      return Min_and_max_coordinates;
    }

References Min_and_max_coordinates.

nsample_points_generated_per_element() [1/2]

unsigned& oomph::SamplePointContainerParameters::nsample_points_generated_per_element ( )

inline

"Measure of" number of sample points generated in each element

    {
      return Nsample_points_generated_per_element;
    }

References Nsample_points_generated_per_element.

nsample_points_generated_per_element() [2/2]

unsigned oomph::SamplePointContainerParameters::nsample_points_generated_per_element ( ) const

inline

"Measure of" number of sample points generated in each element const version

    {
      return Nsample_points_generated_per_element;
    }

References Nsample_points_generated_per_element.

operator=()

void oomph::SamplePointContainerParameters::operator= ( const SamplePointContainerParameters &  )

delete

Broken assignment operator.

use_eulerian_coordinates_during_setup()

bool oomph::SamplePointContainerParameters::use_eulerian_coordinates_during_setup ( ) const

inline

Use eulerian coordinates (via interpolated_x) during setup (otherwise use interpolated_zeta())?

    {
      return Use_eulerian_coordinates_during_setup;
    }

References Use_eulerian_coordinates_during_setup.

Friends And Related Function Documentation

BinArrayParameters

friend class BinArrayParameters

friend

Constructor is private and only accessible by friends to ensure that parameters are set correctly

NonRefineableBinArrayParameters

friend class NonRefineableBinArrayParameters

friend

RefineableBinArrayParameters

friend class RefineableBinArrayParameters

friend

Member Data Documentation

Default_nsample_points_generated_per_element

unsigned oomph::SamplePointContainerParameters::Default_nsample_points_generated_per_element

static

Default for "measure of" number of sample points per element.

Ignore_halo_elements_during_locate_zeta_search

bool oomph::SamplePointContainerParameters::Ignore_halo_elements_during_locate_zeta_search

protected

Ignore halo elements? Accepting halo elements can drastically reduce the number of external halo elements in multidomain problems – currently not aware of any problems with doing this therefore set to false by default but retention of this flag allows easy return to previous implementation.

Referenced by disable_ignore_halo_elements_during_locate_zeta_search(), enable_ignore_halo_elements_during_locate_zeta_search(), and ignore_halo_elements_during_locate_zeta_search().

Mesh_pt

Mesh* oomph::SamplePointContainerParameters::Mesh_pt

protected

Pointer to mesh from whose FiniteElements sample points are created.

Referenced by mesh_pt().

Min_and_max_coordinates

Vector<std::pair<double, double> > oomph::SamplePointContainerParameters::Min_and_max_coordinates

protected

Vector of pairs of doubles for min and maximum coordinates. Call: Min_and_max_coordinates[j] gives me the pair of min (first) and max. (second) coordinates in the j-th coordinate direction.

Referenced by min_and_max_coordinates().

Nsample_points_generated_per_element

unsigned oomph::SamplePointContainerParameters::Nsample_points_generated_per_element

protected

"Measure of" number of sample points generated in each element

Referenced by nsample_points_generated_per_element().

Use_eulerian_coordinates_during_setup

bool oomph::SamplePointContainerParameters::Use_eulerian_coordinates_during_setup

protected

Use Eulerian coordinates to setup bin (i.e. use interpolated_x() rather than interpolated_zeta() when setting up and searching sample point container)

Referenced by disable_use_eulerian_coordinates_during_setup(), enable_use_eulerian_coordinates_during_setup(), and use_eulerian_coordinates_during_setup().

---

The documentation for this class was generated from the following file:

• sample_point_parameters.h