FhSim  3.1.0
Marine systems simulation
Loading...
Searching...
No Matches
marenv::field::IntegrableField Class Referenceabstract

#include <IntegrableField.h>

Public Member Functions

virtual double IntegrateDisk (double x, double y, double z, double radius) const =0
 
virtual void IntegrateBeamProfile (const BeamProfileQuery &query, std::span< double > binMass) const =0
 
virtual double IntegrateCircle2D (double x, double y, double radius) const =0
 
virtual double IntegrateRect2D (double xMin, double xMax, double yMin, double yMax) const =0
 

Detailed Description

A field that integrates itself over disks, beam bins, circles and rectangles.

All queries are const. A caller may use the interface of a field from one object that also implements ScalarField with dynamic_cast<const IntegrableField*>.

The result of a query is the integral of the field's concentration [kg/m^3] over the footprint. A field that is not exact says so in its own documentation.

Member Function Documentation

◆ IntegrateBeamProfile()

virtual void marenv::field::IntegrableField::IntegrateBeamProfile ( const BeamProfileQuery &  query,
std::span< double >  binMass 
) const
pure virtual

Integrates the field over the range bins of one beam.

Bin i is the mass per metre at the bin's midpoint disk times the depth extent of the bin, delta z = binLength * |axis.z|.

Parameters
[in]queryThe beam.
[out]binMassOne value per bin [kg per bin]; its size is the number of bins.

◆ IntegrateCircle2D()

virtual double marenv::field::IntegrableField::IntegrateCircle2D ( double  x,
double  y,
double  radius 
) const
pure virtual

Integrates the depth-integrated field over a circle.

Parameters
[in]xNorth position of the circle centre [m].
[in]yEast position of the circle centre [m].
[in]radiusCircle radius [m].
Returns
The mass inside the circle [kg].

◆ IntegrateDisk()

virtual double marenv::field::IntegrableField::IntegrateDisk ( double  x,
double  y,
double  z,
double  radius 
) const
pure virtual

Integrates the field over a horizontal disk.

Parameters
[in]xNorth position of the disk centre [m].
[in]yEast position of the disk centre [m].
[in]zDepth of the disk plane, positive down [m].
[in]radiusDisk radius [m].
Returns
The mass per metre of depth [kg/m]: the integral of the field over the disk.

◆ IntegrateRect2D()

virtual double marenv::field::IntegrableField::IntegrateRect2D ( double  xMin,
double  xMax,
double  yMin,
double  yMax 
) const
pure virtual

Integrates the depth-integrated field over an axis-aligned rectangle.

Parameters
[in]xMinSouthern edge [m].
[in]xMaxNorthern edge [m].
[in]yMinWestern edge [m].
[in]yMaxEastern edge [m].
Returns
The mass inside the rectangle [kg].

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