Helper object for dealing with the parameters used for the RefineableBinArray objects. 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) | |
| Broken copy constructor. More... | |
| void | operator= (const RefineableBinArrayParameters &) |
| 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... | |
| RefineableBinArray * | root_bin_array_pt () const |
| Pointer to root bin array; const version. 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... | |
| Mesh * | mesh_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_max_depth =100 |
| 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 |
| 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... | |
| RefineableBinArray * | Root_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 | |
| Mesh * | Mesh_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 RefineableBinArray objects.
Definition at line 359 of file sample_point_parameters.h.
Constructor & Destructor Documentation
◆ RefineableBinArrayParameters() [1/2]
|
inline |
Constructor: Pass mesh.
Definition at line 365 of file sample_point_parameters.h.
◆ RefineableBinArrayParameters() [2/2]
|
inline |
Broken copy constructor.
Definition at line 377 of file sample_point_parameters.h.
References oomph::BrokenCopy::broken_copy().
◆ ~RefineableBinArrayParameters()
|
inlinevirtual |
Empty destructor.
Definition at line 390 of file sample_point_parameters.h.
Member Function Documentation
◆ bin_array_is_recursive()
|
inline |
Is bin recursive?
Definition at line 395 of file sample_point_parameters.h.
◆ depth() [1/2]
|
inline |
Variable which stores the Depth value of the bin_array.
Definition at line 413 of file sample_point_parameters.h.
◆ depth() [2/2]
|
inline |
Variable which stores the Depth value of the bin_array. const version.
Definition at line 420 of file sample_point_parameters.h.
◆ disable_bin_array_is_recursive()
|
inline |
Disable recursiveness.
Definition at line 407 of file sample_point_parameters.h.
◆ enable_bin_array_is_recursive()
|
inline |
Enable recursiveness.
Definition at line 401 of file sample_point_parameters.h.
◆ max_depth() [1/2]
|
inline |
Max. depth value of the bin_array.
Definition at line 426 of file sample_point_parameters.h.
◆ max_depth() [2/2]
|
inline |
Max. depth value of the bin_array. const version.
Definition at line 433 of file sample_point_parameters.h.
◆ max_number_of_sample_point_per_bin() [1/2]
|
inline |
Maximum number of sample points in bin (before it's subdivided recursively)
Definition at line 440 of file sample_point_parameters.h.
◆ max_number_of_sample_point_per_bin() [2/2]
|
inline |
Maximum number of sample points in bin (before it's subdivided recursively; const version.
Definition at line 447 of file sample_point_parameters.h.
◆ operator=()
|
inline |
Broken assignment operator.
Definition at line 384 of file sample_point_parameters.h.
References oomph::BrokenCopy::broken_assign().
◆ root_bin_array_pt() [1/2]
|
inline |
Pointer to root bin array.
Definition at line 453 of file sample_point_parameters.h.
◆ root_bin_array_pt() [2/2]
|
inline |
Pointer to root bin array; const version.
Definition at line 459 of file sample_point_parameters.h.
Member Data Documentation
◆ Bin_array_is_recursive
|
private |
Variable which stores if the RefineableBinArray is recursive or not.
Definition at line 474 of file sample_point_parameters.h.
◆ Default_max_depth
|
static |
Default value for max. depth.
Definition at line 465 of file sample_point_parameters.h.
◆ Default_max_number_of_sample_point_per_bin
|
static |
Default value for max. number of sample points before refinement.
Definition at line 468 of file sample_point_parameters.h.
◆ 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 479 of file sample_point_parameters.h.
◆ Max_depth
|
private |
Max. depth value of the bin_array.
Definition at line 482 of file sample_point_parameters.h.
◆ Max_number_of_sample_point_per_bin
|
private |
Maximum number of sample points in bin (before its subdivided recursively.
Definition at line 486 of file sample_point_parameters.h.
◆ Root_bin_array_pt
|
private |
Pointer to root bin array.
Definition at line 489 of file sample_point_parameters.h.
The documentation for this class was generated from the following files: