Public Member Functions | Protected Attributes | Private Member Functions | Friends | List of all members
oomph::BinArrayParameters Class Reference

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

#include <sample_point_parameters.h>

+ Inheritance diagram for oomph::BinArrayParameters:

Public Member Functions

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

Protected Attributes

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

Private Member Functions

 BinArrayParameters (Mesh *mesh_pt)
 Constructor: Pass mesh. Constructor is private and can only be called by the derived friends. More...
 
 BinArrayParameters ()
 Broken default constructor; needed for broken copy constructors. Don't call. It will die. More...
 

Friends

class RefineableBinArrayParameters
 Constructor is private and only accessible by friends. More...
 
class NonRefineableBinArrayParameters
 

Additional Inherited Members

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

Detailed Description

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

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

Definition at line 261 of file sample_point_parameters.h.

Constructor & Destructor Documentation

◆ BinArrayParameters() [1/3]

oomph::BinArrayParameters::BinArrayParameters ( const BinArrayParameters data)
delete

Broken copy constructor.

◆ ~BinArrayParameters()

virtual oomph::BinArrayParameters::~BinArrayParameters ( )
inlinevirtual

Empty destructor.

Definition at line 275 of file sample_point_parameters.h.

◆ BinArrayParameters() [2/3]

oomph::BinArrayParameters::BinArrayParameters ( Mesh mesh_pt)
inlineprivate

Constructor: Pass mesh. Constructor is private and can only be called by the derived friends.

Definition at line 296 of file sample_point_parameters.h.

◆ BinArrayParameters() [3/3]

oomph::BinArrayParameters::BinArrayParameters ( )
inlineprivate

Broken default constructor; needed for broken copy constructors. Don't call. It will die.

Definition at line 302 of file sample_point_parameters.h.

Member Function Documentation

◆ dimensions_of_bin_array() [1/2]

Vector< unsigned > & oomph::BinArrayParameters::dimensions_of_bin_array ( )
inline

Number of bins in each coordinate direction.

Definition at line 278 of file sample_point_parameters.h.

References Dimensions_of_bin_array.

Referenced by oomph::RefineableTriangleMesh< ELEMENT >::adapt().

◆ dimensions_of_bin_array() [2/2]

Vector< unsigned > oomph::BinArrayParameters::dimensions_of_bin_array ( ) const
inline

Number of bins in each coordinate direction. Const version.

Definition at line 284 of file sample_point_parameters.h.

References Dimensions_of_bin_array.

◆ operator=()

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

Broken assignment operator.

Friends And Related Function Documentation

◆ NonRefineableBinArrayParameters

friend class NonRefineableBinArrayParameters
friend

Definition at line 266 of file sample_point_parameters.h.

◆ RefineableBinArrayParameters

friend class RefineableBinArrayParameters
friend

Constructor is private and only accessible by friends.

Definition at line 265 of file sample_point_parameters.h.

Member Data Documentation

◆ Dimensions_of_bin_array

Vector<unsigned> oomph::BinArrayParameters::Dimensions_of_bin_array
protected

Number of bins in each coordinate direction.

Definition at line 291 of file sample_point_parameters.h.

Referenced by dimensions_of_bin_array().


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