Public Member Functions | Static Public Attributes | Protected Attributes | Private Member Functions | Friends | List of all members
oomph::SamplePointContainerParameters Class Reference

///////////////////////////////////////////////////////////////// ///////////////////////////////////////////////////////////////// More...

#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...
 
Meshmesh_pt () const
 Pointer to mesh from whose FiniteElements sample points are created. More...
 
Vector< std::pair< double, double > > & min_and_max_coordinates ()
 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. More...
 
Vector< std::pair< double, double > > min_and_max_coordinates () const
 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. More...
 
unsigned nsample_points_generated_per_element () const
 "Measure of" number of sample points generated in each element const version More...
 
unsigned & nsample_points_generated_per_element ()
 "Measure of" number of sample points generated in each element More...
 
bool use_eulerian_coordinates_during_setup () const
 Use eulerian coordinates (via interpolated_x) during setup (otherwise use interpolated_zeta())? More...
 
void enable_use_eulerian_coordinates_during_setup ()
 Enable use of eulerian coordinates (via interpolated_x) during setup (otherwise use interpolated_zeta()) More...
 
void disable_use_eulerian_coordinates_during_setup ()
 Disable use of eulerian coordinates (via interpolated_x) during setup (otherwise use interpolated_zeta()) More...
 
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 = 5
 Default for "measure of" number of sample points per element. More...
 

Protected Attributes

MeshMesh_pt
 Pointer to mesh from whose FiniteElements sample points are created. More...
 
Vector< std::pair< double, double > > Min_and_max_coordinates
 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. More...
 
unsigned Nsample_points_generated_per_element
 "Measure of" number of sample points generated in each element More...
 
bool Use_eulerian_coordinates_during_setup
 Use Eulerian coordinates to setup bin (i.e. use interpolated_x() rather than interpolated_zeta() when setting up and searching sample point container) More...
 
bool Ignore_halo_elements_during_locate_zeta_search
 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. More...
 

Private Member Functions

 SamplePointContainerParameters (Mesh *mesh_pt)
 Constructor: Pass mesh. Constructor is private and can only be called by the derived friends. More...
 
 SamplePointContainerParameters ()
 Broken default constructor; needed for broken copy constructors. Don't call. It will die. More...
 

Friends

class BinArrayParameters
 Constructor is private and only accessible by friends to ensure that parameters are set correctly. More...
 
class RefineableBinArrayParameters
 
class NonRefineableBinArrayParameters
 
class CGALSamplePointContainerParameters
 

Detailed Description

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

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

Definition at line 69 of file sample_point_parameters.h.

Constructor & Destructor Documentation

◆ SamplePointContainerParameters() [1/3]

oomph::SamplePointContainerParameters::SamplePointContainerParameters ( const SamplePointContainerParameters data)
delete

Broken copy constructor.

◆ ~SamplePointContainerParameters()

virtual oomph::SamplePointContainerParameters::~SamplePointContainerParameters ( )
inlinevirtual

Empty destructor.

Definition at line 89 of file sample_point_parameters.h.

◆ 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.

Definition at line 200 of file sample_point_parameters.h.

◆ SamplePointContainerParameters() [3/3]

oomph::SamplePointContainerParameters::SamplePointContainerParameters ( )
inlineprivate

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

Definition at line 211 of file sample_point_parameters.h.

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)

Definition at line 162 of file sample_point_parameters.h.

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())

Definition at line 144 of file sample_point_parameters.h.

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)

Definition at line 156 of file sample_point_parameters.h.

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())

Definition at line 137 of file sample_point_parameters.h.

References Use_eulerian_coordinates_during_setup.

Referenced by oomph::RefineableGmshTetMesh< ELEMENT >::adapt(), oomph::RefineableTetgenMesh< ELEMENT >::adapt(), and oomph::RefineableTriangleMesh< ELEMENT >::adapt().

◆ ignore_halo_elements_during_locate_zeta_search()

bool oomph::SamplePointContainerParameters::ignore_halo_elements_during_locate_zeta_search ( ) const
inline

Ignore halo elements? (MPI only)

Definition at line 150 of file sample_point_parameters.h.

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.

Definition at line 92 of file sample_point_parameters.h.

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.

Definition at line 101 of file sample_point_parameters.h.

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.

Definition at line 110 of file sample_point_parameters.h.

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

Definition at line 123 of file sample_point_parameters.h.

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

Definition at line 117 of file sample_point_parameters.h.

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())?

Definition at line 130 of file sample_point_parameters.h.

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.

Definition at line 74 of file sample_point_parameters.h.

◆ CGALSamplePointContainerParameters

Definition at line 78 of file sample_point_parameters.h.

◆ NonRefineableBinArrayParameters

friend class NonRefineableBinArrayParameters
friend

Definition at line 76 of file sample_point_parameters.h.

◆ RefineableBinArrayParameters

friend class RefineableBinArrayParameters
friend

Definition at line 75 of file sample_point_parameters.h.

Member Data Documentation

◆ Default_nsample_points_generated_per_element

unsigned oomph::SamplePointContainerParameters::Default_nsample_points_generated_per_element = 5
static

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

Definition at line 168 of file sample_point_parameters.h.

◆ 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.

Definition at line 193 of file sample_point_parameters.h.

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.

Definition at line 172 of file sample_point_parameters.h.

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.

Definition at line 178 of file sample_point_parameters.h.

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

Definition at line 181 of file sample_point_parameters.h.

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)

Definition at line 186 of file sample_point_parameters.h.

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 files: