ESPResSo
Extensible Simulation Package for Research on Soft Matter Systems
Loading...
Searching...
No Matches
Observables::CylindricalProfileObservable Class Reference

Cylindrical profile observable. More...

#include <CylindricalProfileObservable.hpp>

+ Inheritance diagram for Observables::CylindricalProfileObservable:
+ Collaboration diagram for Observables::CylindricalProfileObservable:

Public Member Functions

 CylindricalProfileObservable (std::shared_ptr< Utils::CylindricalTransformationParameters > transform_params, int n_r_bins, int n_phi_bins, int n_z_bins, double min_r, double max_r, double min_phi, double max_phi, double min_z, double max_z)
 
- 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::shared_ptr< Utils::CylindricalTransformationParameterstransform_params
 

Detailed Description

Cylindrical profile observable.

Definition at line 32 of file CylindricalProfileObservable.hpp.

Constructor & Destructor Documentation

◆ CylindricalProfileObservable()

Observables::CylindricalProfileObservable::CylindricalProfileObservable ( std::shared_ptr< Utils::CylindricalTransformationParameters transform_params,
int  n_r_bins,
int  n_phi_bins,
int  n_z_bins,
double  min_r,
double  max_r,
double  min_phi,
double  max_phi,
double  min_z,
double  max_z 
)
inline

Definition at line 34 of file CylindricalProfileObservable.hpp.

Member Data Documentation

◆ transform_params


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