Observables::LBProfileObservable Class Reference

#include <LBProfileObservable.hpp>

Inheritance diagram for Observables::LBProfileObservable:

Collaboration diagram for Observables::LBProfileObservable:

Public Member Functions
	LBProfileObservable (double sampling_delta_x, double sampling_delta_y, double sampling_delta_z, double sampling_offset_x, double sampling_offset_y, double sampling_offset_z, int n_x_bins, int n_y_bins, int n_z_bins, double min_x, double max_x, double min_y, double max_y, double min_z, double max_z, bool allow_empty_bins=false)
void	calculate_sampling_positions (auto const &box_geo, auto const &lb) const
Public Member Functions inherited from Observables::ProfileObservable
	ProfileObservable (int n_x_bins, int n_y_bins, int n_z_bins, double min_x, double max_x, double min_y, double max_y, double min_z, double max_z)
std::vector< std::size_t >	shape () const override
auto	n_bins () const
auto	limits () const
std::array< std::vector< double >, 3 >	edges () const
	Calculate the bin edges for each dimension.
Public Member Functions inherited from Observables::Observable
	Observable ()=default
virtual	~Observable ()=default
virtual std::vector< double >	operator() (boost::mpi::communicator const &comm) const =0
	Calculate the set of values measured by the observable.
std::size_t	n_values () const
	Size of the flat array returned by the observable.

Public Attributes
std::array< double, 3 >	sampling_delta
std::array< double, 3 >	sampling_offset
bool	allow_empty_bins

Protected Attributes
SanityChecksLB	lb_sanity_checks
std::vector< Utils::Vector3d >	sampling_positions

Detailed Description

Definition at line 37 of file core/observables/LBProfileObservable.hpp.

Constructor & Destructor Documentation

LBProfileObservable()

Observables::LBProfileObservable::LBProfileObservable ( double  sampling_delta_x, double  sampling_delta_y, double  sampling_delta_z, double  sampling_offset_x, double  sampling_offset_y, double  sampling_offset_z, int  n_x_bins, int  n_y_bins, int  n_z_bins, double  min_x, double  max_x, double  min_y, double  max_y, double  min_z, double  max_z, bool  allow_empty_bins = false  )

inline

Definition at line 39 of file core/observables/LBProfileObservable.hpp.

Member Function Documentation

calculate_sampling_positions()

void Observables::LBProfileObservable::calculate_sampling_positions ( auto const &  box_geo, auto const &  lb  ) const

inline

Definition at line 73 of file core/observables/LBProfileObservable.hpp.

References Utils::Vector< T, N >::broadcast(), and lb_sanity_checks().

Referenced by Observables::LBVelocityProfile::operator()().

Member Data Documentation

allow_empty_bins

bool Observables::LBProfileObservable::allow_empty_bins

Definition at line 66 of file core/observables/LBProfileObservable.hpp.

Referenced by Observables::LBVelocityProfile::operator()().

lb_sanity_checks

SanityChecksLB Observables::LBProfileObservable::lb_sanity_checks

mutableprotected

Definition at line 69 of file core/observables/LBProfileObservable.hpp.

Referenced by Observables::LBVelocityProfile::operator()().

sampling_delta

std::array<double, 3> Observables::LBProfileObservable::sampling_delta

Definition at line 64 of file core/observables/LBProfileObservable.hpp.

sampling_offset

std::array<double, 3> Observables::LBProfileObservable::sampling_offset

Definition at line 65 of file core/observables/LBProfileObservable.hpp.

sampling_positions

std::vector<Utils::Vector3d> Observables::LBProfileObservable::sampling_positions

mutableprotected

Definition at line 70 of file core/observables/LBProfileObservable.hpp.

Referenced by Observables::LBVelocityProfile::operator()().

---

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

• core/observables/LBProfileObservable.hpp