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

#include <sample_point_parameters.h>

Inheritance diagram for oomph::NonRefineableBinArrayParameters:

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

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

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

virtual	~NonRefineableBinArrayParameters ()
	Empty destructor.

unsigned	nspiral_chunk () const
	Number of spirals that are being visited before doing another circular mpi communication const version.

unsigned &	nspiral_chunk ()
	Number of spirals that are being visited before doing another circular mpi communication.

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

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

virtual	~BinArrayParameters ()
	Empty destructor.

Vector< unsigned > &	dimensions_of_bin_array ()
	Number of bins in each coordinate direction.

Vector< unsigned >	dimensions_of_bin_array () const
	Number of bins in each coordinate direction. Const version.

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)

Static Public Attributes
static unsigned	Default_nspiral_chunk
	Default value for number of spirals that are being visited before doing another circular mpi communication.

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.

Private Attributes
unsigned	Nspiral_chunk
	Number of spirals that are being visited before doing another circular mpi communication.

Additional Inherited Members
Protected Attributes inherited from oomph::BinArrayParameters
Vector< unsigned >	Dimensions_of_bin_array
	Number of bins in each coordinate direction.

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 NonRefineableBinArray objects.

Definition at line 455 of file sample_point_parameters.h.

Constructor & Destructor Documentation

◆ NonRefineableBinArrayParameters() [1/2]

oomph::NonRefineableBinArrayParameters::NonRefineableBinArrayParameters ( Mesh * mesh_pt )

inline

Constructor: Pass mesh.

Definition at line 459 of file sample_point_parameters.h.

◆ NonRefineableBinArrayParameters() [2/2]

oomph::NonRefineableBinArrayParameters::NonRefineableBinArrayParameters ( const NonRefineableBinArrayParameters & data )

delete

Broken copy constructor.

◆ ~NonRefineableBinArrayParameters()

virtual oomph::NonRefineableBinArrayParameters::~NonRefineableBinArrayParameters ( )

inlinevirtual

Empty destructor.

Definition at line 474 of file sample_point_parameters.h.

Member Function Documentation

◆ nspiral_chunk() [1/2]

unsigned & oomph::NonRefineableBinArrayParameters::nspiral_chunk ( )

inline

Number of spirals that are being visited before doing another circular mpi communication.

Definition at line 485 of file sample_point_parameters.h.

References Nspiral_chunk.

◆ nspiral_chunk() [2/2]

unsigned oomph::NonRefineableBinArrayParameters::nspiral_chunk ( ) const

inline

Number of spirals that are being visited before doing another circular mpi communication const version.

Definition at line 479 of file sample_point_parameters.h.

References Nspiral_chunk.

◆ operator=()

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

delete

Broken assignment operator.

Member Data Documentation

◆ Default_nspiral_chunk

unsigned oomph::NonRefineableBinArrayParameters::Default_nspiral_chunk

static

Initial value:

=

10

Default value for number of spirals that are being visited before doing another circular mpi communication.

Definition at line 492 of file sample_point_parameters.h.

◆ Nspiral_chunk

unsigned oomph::NonRefineableBinArrayParameters::Nspiral_chunk

private

Number of spirals that are being visited before doing another circular mpi communication.

Definition at line 497 of file sample_point_parameters.h.

Referenced by nspiral_chunk(), and nspiral_chunk().

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

Public Member Functions

Static Public Attributes

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ NonRefineableBinArrayParameters() [1/2]

◆ NonRefineableBinArrayParameters() [2/2]

◆ ~NonRefineableBinArrayParameters()

Member Function Documentation

◆ nspiral_chunk() [1/2]

◆ nspiral_chunk() [2/2]

◆ operator=()

Member Data Documentation

◆ Default_nspiral_chunk

◆ Nspiral_chunk