Public Member Functions | Static Public Attributes | Private Attributes | List of all members
oomph::NonRefineableBinArrayParameters Class Reference

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. More...
 
 NonRefineableBinArrayParameters (const NonRefineableBinArrayParameters &data)
 Broken copy constructor. More...
 
void operator= (const NonRefineableBinArrayParameters &)
 Broken assignment operator. More...
 
virtual ~NonRefineableBinArrayParameters ()
 Empty destructor. More...
 
unsigned nspiral_chunk () const
 Number of spirals that are being visited before doing another circular mpi communication const version. More...
 
unsigned & nspiral_chunk ()
 Number of spirals that are being visited before doing another circular mpi communication. More...
 
- Public Member Functions inherited from oomph::BinArrayParameters
 BinArrayParameters (const BinArrayParameters &data)
 Broken copy constructor. More...
 
void operator= (const BinArrayParameters &)
 Broken assignment operator. More...
 
virtual ~BinArrayParameters ()
 Empty destructor. More...
 
Vector< unsigned > & dimensions_of_bin_array ()
 Number of bins in each coordinate direction. More...
 
Vector< unsigned > dimensions_of_bin_array () const
 Number of bins in each coordinate direction. Const version. More...
 
- Public Member Functions inherited from oomph::SamplePointContainerParameters
 SamplePointContainerParameters (const SamplePointContainerParameters &data)
 Broken copy constructor. More...
 
void operator= (const SamplePointContainerParameters &)
 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 ()
 
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_nspiral_chunk =10
 Default value for number of spirals that are being visited before doing another circular mpi communication. More...
 
- Static Public Attributes inherited from oomph::SamplePointContainerParameters
static unsigned Default_nsample_points_generated_per_element
 Default for "measure of" number of sample points per element. More...
 

Private Attributes

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

Additional Inherited Members

- Protected Attributes inherited from oomph::BinArrayParameters
Vector< unsigned > Dimensions_of_bin_array
 Number of bins in each coordinate direction. More...
 
- Protected Attributes inherited from oomph::SamplePointContainerParameters
MeshMesh_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
 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...
 

Detailed Description

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

Definition at line 508 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 514 of file sample_point_parameters.h.

◆ NonRefineableBinArrayParameters() [2/2]

oomph::NonRefineableBinArrayParameters::NonRefineableBinArrayParameters ( const NonRefineableBinArrayParameters data)
inline

Broken copy constructor.

Definition at line 521 of file sample_point_parameters.h.

References oomph::BrokenCopy::broken_copy().

◆ ~NonRefineableBinArrayParameters()

virtual oomph::NonRefineableBinArrayParameters::~NonRefineableBinArrayParameters ( )
inlinevirtual

Empty destructor.

Definition at line 534 of file sample_point_parameters.h.

Member Function Documentation

◆ nspiral_chunk() [1/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 540 of file sample_point_parameters.h.

◆ nspiral_chunk() [2/2]

unsigned& oomph::NonRefineableBinArrayParameters::nspiral_chunk ( )
inline

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

Definition at line 546 of file sample_point_parameters.h.

◆ operator=()

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

Broken assignment operator.

Definition at line 528 of file sample_point_parameters.h.

References oomph::BrokenCopy::broken_assign().

Member Data Documentation

◆ Default_nspiral_chunk

unsigned oomph::NonRefineableBinArrayParameters::Default_nspiral_chunk =10
static

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

Definition at line 553 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 559 of file sample_point_parameters.h.


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