oomph::RefineableBinArrayParameters Class Reference

#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
unsigned &	max_depth ()
	Max. depth value of the bin_array. More...
unsigned	max_depth () const
unsigned &	max_number_of_sample_point_per_bin ()
unsigned	max_number_of_sample_point_per_bin () const
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)=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...
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< std::pair< double, double > >	min_and_max_coordinates () const
unsigned	nsample_points_generated_per_element () const
unsigned &	nsample_points_generated_per_element ()
	"Measure of" number of sample points generated in each element More...
bool	use_eulerian_coordinates_during_setup () const
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
	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
unsigned	Depth
unsigned	Max_depth
	Max. depth value of the bin_array. More...
unsigned	Max_number_of_sample_point_per_bin
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
bool	Ignore_halo_elements_during_locate_zeta_search

Detailed Description

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

Constructor & Destructor Documentation

RefineableBinArrayParameters() [1/2]

oomph::RefineableBinArrayParameters::RefineableBinArrayParameters ( Mesh *  mesh_pt )

inline

Constructor: Pass mesh.

      : SamplePointContainerParameters(mesh_pt),
        BinArrayParameters(mesh_pt),
        Bin_array_is_recursive(true),
        Depth(0),
        Max_depth(Default_max_depth),
        Max_number_of_sample_point_per_bin(
          Default_max_number_of_sample_point_per_bin),
        Root_bin_array_pt(0)
    {
    }

RefineableBinArrayParameters() [2/2]

oomph::RefineableBinArrayParameters::RefineableBinArrayParameters ( const RefineableBinArrayParameters &  data )

delete

Broken copy constructor.

~RefineableBinArrayParameters()

virtual oomph::RefineableBinArrayParameters::~RefineableBinArrayParameters ( )

inlinevirtual

Empty destructor.

{}

Member Function Documentation

bin_array_is_recursive()

bool oomph::RefineableBinArrayParameters::bin_array_is_recursive ( ) const

inline

Is bin recursive?

    {
      return Bin_array_is_recursive;
    }

References Bin_array_is_recursive.

depth() [1/2]

unsigned& oomph::RefineableBinArrayParameters::depth ( )

inline

Variable which stores the Depth value of the bin_array.

    {
      return Depth;
    }

References Depth.

depth() [2/2]

unsigned oomph::RefineableBinArrayParameters::depth ( ) const

inline

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

    {
      return Depth;
    }

References Depth.

disable_bin_array_is_recursive()

void oomph::RefineableBinArrayParameters::disable_bin_array_is_recursive ( )

inline

Disable recursiveness.

    {
      Bin_array_is_recursive = false;
    }

References Bin_array_is_recursive.

enable_bin_array_is_recursive()

void oomph::RefineableBinArrayParameters::enable_bin_array_is_recursive ( )

inline

Enable recursiveness.

    {
      Bin_array_is_recursive = true;
    }

References Bin_array_is_recursive.

max_depth() [1/2]

unsigned& oomph::RefineableBinArrayParameters::max_depth ( )

inline

Max. depth value of the bin_array.

    {
      return Max_depth;
    }

References Max_depth.

max_depth() [2/2]

unsigned oomph::RefineableBinArrayParameters::max_depth ( ) const

inline

Max. depth value of the bin_array. const version

    {
      return Max_depth;
    }

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)

    {
      return Max_number_of_sample_point_per_bin;
    }

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

    {
      return Max_number_of_sample_point_per_bin;
    }

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.

    {
      return Root_bin_array_pt;
    }

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.

    {
      return Root_bin_array_pt;
    }

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.

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.

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.

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.

Referenced by depth().

Max_depth

unsigned oomph::RefineableBinArrayParameters::Max_depth

private

Max. depth value of the bin_array.

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

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.

Referenced by root_bin_array_pt().

---

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

• sample_point_parameters.h
• sample_point_parameters.cc