Helper object for dealing with the parameters used for the CGALSamplePointContainer objects. More...

#include <sample_point_parameters.h>

Inheritance diagram for oomph::CGALSamplePointContainerParameters:

Public Member Functions
	CGALSamplePointContainerParameters (Mesh *mesh_pt)
	Constructor: Pass mesh.

	CGALSamplePointContainerParameters (const CGALSamplePointContainerParameters &data)=delete
	Broken copy constructor.

void	operator= (const CGALSamplePointContainerParameters &)=delete
	Broken assignment operator.

Public Member Functions inherited from oomph::SamplePointContainerParameters
	SamplePointContainerParameters (const SamplePointContainerParameters &data)=delete
	Broken copy constructor.

void	operator= (const SamplePointContainerParameters &)=delete
	Broken assignment operator.

virtual	~SamplePointContainerParameters ()
	Empty destructor.

Mesh *	mesh_pt () const
	Pointer to mesh from whose FiniteElements sample points are created.

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.

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.

unsigned	nsample_points_generated_per_element () const
	"Measure of" number of sample points generated in each element const version

unsigned &	nsample_points_generated_per_element ()
	"Measure of" number of sample points generated in each element

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

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

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

bool	ignore_halo_elements_during_locate_zeta_search () const
	Ignore halo elements? (MPI only)

void	enable_ignore_halo_elements_during_locate_zeta_search ()
	Enable Ignore halo elements? (MPI only)

void	disable_ignore_halo_elements_during_locate_zeta_search ()
	Disable Ignore halo elements? (MPI only)

Additional Inherited Members
Static Public Attributes inherited from oomph::SamplePointContainerParameters
static unsigned	Default_nsample_points_generated_per_element = 5
	Default for "measure of" number of sample points per element.

Protected Attributes inherited from oomph::SamplePointContainerParameters
Mesh *	Mesh_pt
	Pointer to mesh from whose FiniteElements sample points are created.

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.

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

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)

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.

Detailed Description

Helper object for dealing with the parameters used for the CGALSamplePointContainer objects.

Definition at line 231 of file sample_point_parameters.h.

Constructor & Destructor Documentation

◆ CGALSamplePointContainerParameters() [1/2]

oomph::CGALSamplePointContainerParameters::CGALSamplePointContainerParameters ( Mesh * mesh_pt )

inline

Constructor: Pass mesh.

Definition at line 236 of file sample_point_parameters.h.

◆ CGALSamplePointContainerParameters() [2/2]

oomph::CGALSamplePointContainerParameters::CGALSamplePointContainerParameters ( const CGALSamplePointContainerParameters & data )

delete

Broken copy constructor.

Member Function Documentation

◆ operator=()

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

delete

Broken assignment operator.

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

sample_point_parameters.h