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

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

Protected Attributes
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

Private Member Functions
	BinArrayParameters (Mesh *mesh_pt)

	BinArrayParameters ()

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

Constructor & Destructor Documentation

◆ BinArrayParameters() [1/3]

oomph::BinArrayParameters::BinArrayParameters ( const BinArrayParameters & data )

delete

Broken copy constructor.

◆ ~BinArrayParameters()

virtual oomph::BinArrayParameters::~BinArrayParameters ( )

inlinevirtual

Empty destructor.

275 {}

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

                                       : SamplePointContainerParameters(mesh_pt)
     {
     }

◆ BinArrayParameters() [3/3]

oomph::BinArrayParameters::BinArrayParameters ( )

inlineprivate

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

     {
       // Throw the error
       throw OomphLibError("Broken default constructor. Don't call this!",
                           OOMPH_CURRENT_FUNCTION,
                           OOMPH_EXCEPTION_LOCATION);
     }

References OOMPH_CURRENT_FUNCTION, and OOMPH_EXCEPTION_LOCATION.

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.

     {
       return Dimensions_of_bin_array;
     }

References Dimensions_of_bin_array.

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

     {
       return Dimensions_of_bin_array;
     }

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

◆ RefineableBinArrayParameters

friend class RefineableBinArrayParameters

friend

Constructor is private and only accessible by friends.

Member Data Documentation

◆ Dimensions_of_bin_array

Vector<unsigned> oomph::BinArrayParameters::Dimensions_of_bin_array

protected

Number of bins in each coordinate direction.

Referenced by dimensions_of_bin_array().

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

sample_point_parameters.h

Public Member Functions

Protected Attributes

Private Member Functions

Friends

Additional Inherited Members