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

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

#include <sample_point_parameters.h>

+ Inheritance diagram for oomph::RefineableBinArrayParameters:

Public Member Functions

 RefineableBinArrayParameters (Mesh *mesh_pt)
 Constructor: Pass mesh. More...
 
 RefineableBinArrayParameters (const RefineableBinArrayParameters &data)=delete
 Broken copy constructor. More...
 
void operator= (const RefineableBinArrayParameters &)=delete
 Broken assignment operator. More...
 
virtual ~RefineableBinArrayParameters ()
 Empty destructor. More...
 
bool bin_array_is_recursive () const
 Is bin recursive? More...
 
void enable_bin_array_is_recursive ()
 Enable recursiveness. More...
 
void disable_bin_array_is_recursive ()
 Disable recursiveness. More...
 
unsigned & depth ()
 Variable which stores the Depth value of the bin_array. More...
 
unsigned depth () const
 Variable which stores the Depth value of the bin_array. const version. More...
 
unsigned & max_depth ()
 Max. depth value of the bin_array. More...
 
unsigned max_depth () const
 Max. depth value of the bin_array. const version. More...
 
unsigned & max_number_of_sample_point_per_bin ()
 Maximum number of sample points in bin (before it's subdivided recursively) More...
 
unsigned max_number_of_sample_point_per_bin () const
 Maximum number of sample points in bin (before it's subdivided recursively; const version. More...
 
RefineableBinArray *& root_bin_array_pt ()
 Pointer to root bin array. More...
 
RefineableBinArrayroot_bin_array_pt () const
 Pointer to root bin array; const version. More...
 
- Public Member Functions inherited from oomph::BinArrayParameters
 BinArrayParameters (const BinArrayParameters &data)=delete
 Broken copy constructor. More...
 
void operator= (const BinArrayParameters &)=delete
 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)=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_max_depth
 Default value for max. depth. More...
 
static unsigned Default_max_number_of_sample_point_per_bin
 Default value for max. number of sample points before refinement. More...
 
- 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. More...
 

Private Attributes

bool Bin_array_is_recursive
 Variable which stores if the RefineableBinArray is recursive or not. More...
 
unsigned Depth
 Variable which stores the Depth value of the bin_array. Useful for debugging and for preventing "infinite" recursion in case if there is a problem. More...
 
unsigned Max_depth
 Max. depth value of the bin_array. More...
 
unsigned Max_number_of_sample_point_per_bin
 Maximum number of sample points in bin (before its subdivided recursively. More...
 
RefineableBinArrayRoot_bin_array_pt
 Pointer to root bin array. 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
 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...
 

Detailed Description

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

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

Definition at line 321 of file sample_point_parameters.h.

Constructor & Destructor Documentation

◆ RefineableBinArrayParameters() [1/2]

oomph::RefineableBinArrayParameters::RefineableBinArrayParameters ( Mesh mesh_pt)
inline

Constructor: Pass mesh.

Definition at line 325 of file sample_point_parameters.h.

◆ RefineableBinArrayParameters() [2/2]

oomph::RefineableBinArrayParameters::RefineableBinArrayParameters ( const RefineableBinArrayParameters data)
delete

Broken copy constructor.

◆ ~RefineableBinArrayParameters()

virtual oomph::RefineableBinArrayParameters::~RefineableBinArrayParameters ( )
inlinevirtual

Empty destructor.

Definition at line 345 of file sample_point_parameters.h.

Member Function Documentation

◆ bin_array_is_recursive()

bool oomph::RefineableBinArrayParameters::bin_array_is_recursive ( ) const
inline

Is bin recursive?

Definition at line 349 of file sample_point_parameters.h.

References Bin_array_is_recursive.

◆ depth() [1/2]

unsigned & oomph::RefineableBinArrayParameters::depth ( )
inline

Variable which stores the Depth value of the bin_array.

Definition at line 367 of file sample_point_parameters.h.

References Depth.

◆ depth() [2/2]

unsigned oomph::RefineableBinArrayParameters::depth ( ) const
inline

Variable which stores the Depth value of the bin_array. const version.

Definition at line 374 of file sample_point_parameters.h.

References Depth.

◆ disable_bin_array_is_recursive()

void oomph::RefineableBinArrayParameters::disable_bin_array_is_recursive ( )
inline

Disable recursiveness.

Definition at line 361 of file sample_point_parameters.h.

References Bin_array_is_recursive.

◆ enable_bin_array_is_recursive()

void oomph::RefineableBinArrayParameters::enable_bin_array_is_recursive ( )
inline

Enable recursiveness.

Definition at line 355 of file sample_point_parameters.h.

References Bin_array_is_recursive.

◆ max_depth() [1/2]

unsigned & oomph::RefineableBinArrayParameters::max_depth ( )
inline

Max. depth value of the bin_array.

Definition at line 380 of file sample_point_parameters.h.

References Max_depth.

◆ max_depth() [2/2]

unsigned oomph::RefineableBinArrayParameters::max_depth ( ) const
inline

Max. depth value of the bin_array. const version.

Definition at line 387 of file sample_point_parameters.h.

References Max_depth.

◆ max_number_of_sample_point_per_bin() [1/2]

unsigned & oomph::RefineableBinArrayParameters::max_number_of_sample_point_per_bin ( )
inline

Maximum number of sample points in bin (before it's subdivided recursively)

Definition at line 394 of file sample_point_parameters.h.

References Max_number_of_sample_point_per_bin.

◆ max_number_of_sample_point_per_bin() [2/2]

unsigned oomph::RefineableBinArrayParameters::max_number_of_sample_point_per_bin ( ) const
inline

Maximum number of sample points in bin (before it's subdivided recursively; const version.

Definition at line 401 of file sample_point_parameters.h.

References Max_number_of_sample_point_per_bin.

◆ operator=()

void oomph::RefineableBinArrayParameters::operator= ( const RefineableBinArrayParameters )
delete

Broken assignment operator.

◆ root_bin_array_pt() [1/2]

RefineableBinArray *& oomph::RefineableBinArrayParameters::root_bin_array_pt ( )
inline

Pointer to root bin array.

Definition at line 407 of file sample_point_parameters.h.

References Root_bin_array_pt.

◆ root_bin_array_pt() [2/2]

RefineableBinArray * oomph::RefineableBinArrayParameters::root_bin_array_pt ( ) const
inline

Pointer to root bin array; const version.

Definition at line 413 of file sample_point_parameters.h.

References Root_bin_array_pt.

Member Data Documentation

◆ Bin_array_is_recursive

bool oomph::RefineableBinArrayParameters::Bin_array_is_recursive
private

Variable which stores if the RefineableBinArray is recursive or not.

Definition at line 427 of file sample_point_parameters.h.

Referenced by bin_array_is_recursive(), disable_bin_array_is_recursive(), and enable_bin_array_is_recursive().

◆ Default_max_depth

unsigned oomph::RefineableBinArrayParameters::Default_max_depth
static
Initial value:
=
100

Default value for max. depth.

Definition at line 419 of file sample_point_parameters.h.

◆ Default_max_number_of_sample_point_per_bin

unsigned oomph::RefineableBinArrayParameters::Default_max_number_of_sample_point_per_bin
static
Initial value:
=
15

Default value for max. number of sample points before refinement.

Definition at line 422 of file sample_point_parameters.h.

◆ Depth

unsigned oomph::RefineableBinArrayParameters::Depth
private

Variable which stores the Depth value of the bin_array. Useful for debugging and for preventing "infinite" recursion in case if there is a problem.

Definition at line 432 of file sample_point_parameters.h.

Referenced by depth().

◆ Max_depth

unsigned oomph::RefineableBinArrayParameters::Max_depth
private

Max. depth value of the bin_array.

Definition at line 435 of file sample_point_parameters.h.

Referenced by max_depth().

◆ Max_number_of_sample_point_per_bin

unsigned oomph::RefineableBinArrayParameters::Max_number_of_sample_point_per_bin
private

Maximum number of sample points in bin (before its subdivided recursively.

Definition at line 439 of file sample_point_parameters.h.

Referenced by max_number_of_sample_point_per_bin().

◆ Root_bin_array_pt

RefineableBinArray* oomph::RefineableBinArrayParameters::Root_bin_array_pt
private

Pointer to root bin array.

Definition at line 442 of file sample_point_parameters.h.

Referenced by root_bin_array_pt().


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