Helper object for dealing with the parameters used for the SamplePointContainer objects. More...
#include <sample_point_parameters.h>
Inheritance diagram for oomph::SamplePointContainerParameters:
Public Member Functions | |
| 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_nsample_points_generated_per_element |
| Default for "measure of" number of sample points per element. More... | |
Protected Attributes | |
| 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... | |
Private Member Functions | |
| SamplePointContainerParameters (Mesh *mesh_pt) | |
| Constructor: Pass mesh. Constructor is private and can only be called by the derived friends. More... | |
| SamplePointContainerParameters () | |
| Broken default constructor; needed for broken copy constructors. Don't call. It will die. More... | |
Friends | |
| class | BinArrayParameters |
| Constructor is private and only accessible by friends to ensure that parameters are set correctly. More... | |
| class | RefineableBinArrayParameters |
| class | NonRefineableBinArrayParameters |
| class | CGALSamplePointContainerParameters |
Detailed Description
Helper object for dealing with the parameters used for the SamplePointContainer objects.
Definition at line 78 of file sample_point_parameters.h.
Constructor & Destructor Documentation
◆ SamplePointContainerParameters() [1/3]
|
inline |
Broken copy constructor.
Definition at line 93 of file sample_point_parameters.h.
References oomph::BrokenCopy::broken_copy().
◆ ~SamplePointContainerParameters()
|
inlinevirtual |
Empty destructor.
Definition at line 106 of file sample_point_parameters.h.
◆ SamplePointContainerParameters() [2/3]
|
inlineprivate |
Constructor: Pass mesh. Constructor is private and can only be called by the derived friends.
Definition at line 219 of file sample_point_parameters.h.
◆ SamplePointContainerParameters() [3/3]
|
inlineprivate |
Broken default constructor; needed for broken copy constructors. Don't call. It will die.
Definition at line 229 of file sample_point_parameters.h.
Member Function Documentation
◆ disable_ignore_halo_elements_during_locate_zeta_search()
|
inline |
Disable Ignore halo elements? (MPI only)
Definition at line 179 of file sample_point_parameters.h.
References Ignore_halo_elements_during_locate_zeta_search.
◆ disable_use_eulerian_coordinates_during_setup()
|
inline |
Disable use of eulerian coordinates (via interpolated_x) during setup (otherwise use interpolated_zeta())
Definition at line 161 of file sample_point_parameters.h.
References Use_eulerian_coordinates_during_setup.
◆ enable_ignore_halo_elements_during_locate_zeta_search()
|
inline |
Enable Ignore halo elements? (MPI only)
Definition at line 173 of file sample_point_parameters.h.
References Ignore_halo_elements_during_locate_zeta_search.
◆ enable_use_eulerian_coordinates_during_setup()
|
inline |
Enable use of eulerian coordinates (via interpolated_x) during setup (otherwise use interpolated_zeta())
Definition at line 154 of file sample_point_parameters.h.
References Use_eulerian_coordinates_during_setup.
Referenced by oomph::RefineableTetgenMesh< ELEMENT >::adapt(), oomph::RefineableGmshTetMesh< ELEMENT >::adapt(), and oomph::RefineableTriangleMesh< ELEMENT >::adapt().
◆ ignore_halo_elements_during_locate_zeta_search()
|
inline |
Ignore halo elements? (MPI only)
Definition at line 167 of file sample_point_parameters.h.
References Ignore_halo_elements_during_locate_zeta_search.
◆ mesh_pt()
|
inline |
Pointer to mesh from whose FiniteElements sample points are created.
Definition at line 109 of file sample_point_parameters.h.
References Mesh_pt.
Referenced by oomph::MeshAsGeomObject::build_it().
◆ min_and_max_coordinates() [1/2]
|
inline |
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.
Definition at line 118 of file sample_point_parameters.h.
References Min_and_max_coordinates.
◆ min_and_max_coordinates() [2/2]
|
inline |
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.
Definition at line 127 of file sample_point_parameters.h.
References Min_and_max_coordinates.
◆ nsample_points_generated_per_element() [1/2]
|
inline |
"Measure of" number of sample points generated in each element const version
Definition at line 134 of file sample_point_parameters.h.
References Nsample_points_generated_per_element.
◆ nsample_points_generated_per_element() [2/2]
|
inline |
"Measure of" number of sample points generated in each element
Definition at line 140 of file sample_point_parameters.h.
References Nsample_points_generated_per_element.
◆ operator=()
|
inline |
Broken assignment operator.
Definition at line 99 of file sample_point_parameters.h.
References oomph::BrokenCopy::broken_assign().
◆ use_eulerian_coordinates_during_setup()
|
inline |
Use eulerian coordinates (via interpolated_x) during setup (otherwise use interpolated_zeta())?
Definition at line 147 of file sample_point_parameters.h.
References Use_eulerian_coordinates_during_setup.
Friends And Related Function Documentation
◆ BinArrayParameters
|
friend |
Constructor is private and only accessible by friends to ensure that parameters are set correctly.
Definition at line 85 of file sample_point_parameters.h.
◆ CGALSamplePointContainerParameters
|
friend |
Definition at line 89 of file sample_point_parameters.h.
◆ NonRefineableBinArrayParameters
|
friend |
Definition at line 87 of file sample_point_parameters.h.
◆ RefineableBinArrayParameters
|
friend |
Definition at line 86 of file sample_point_parameters.h.
Member Data Documentation
◆ Default_nsample_points_generated_per_element
|
static |
Default for "measure of" number of sample points per element.
Definition at line 185 of file sample_point_parameters.h.
Referenced by oomph::Multi_domain_functions::aux_setup_multi_domain_interaction().
◆ Ignore_halo_elements_during_locate_zeta_search
|
protected |
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.
Definition at line 211 of file sample_point_parameters.h.
Referenced by disable_ignore_halo_elements_during_locate_zeta_search(), enable_ignore_halo_elements_during_locate_zeta_search(), and ignore_halo_elements_during_locate_zeta_search().
◆ Mesh_pt
|
protected |
Pointer to mesh from whose FiniteElements sample points are created.
Definition at line 190 of file sample_point_parameters.h.
Referenced by mesh_pt().
◆ Min_and_max_coordinates
|
protected |
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.
Definition at line 196 of file sample_point_parameters.h.
Referenced by min_and_max_coordinates().
◆ Nsample_points_generated_per_element
|
protected |
"Measure of" number of sample points generated in each element
Definition at line 199 of file sample_point_parameters.h.
Referenced by nsample_points_generated_per_element().
◆ Use_eulerian_coordinates_during_setup
|
protected |
Use Eulerian coordinates to setup bin (i.e. use interpolated_x() rather than interpolated_zeta() when setting up and searching sample point container)
Definition at line 204 of file sample_point_parameters.h.
Referenced by disable_use_eulerian_coordinates_during_setup(), enable_use_eulerian_coordinates_during_setup(), and use_eulerian_coordinates_during_setup().
The documentation for this class was generated from the following file: