|
FhSim
3.1.0
Marine systems simulation
|
#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 |
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.
|
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|.
| [in] | query | The beam. |
| [out] | binMass | One value per bin [kg per bin]; its size is the number of bins. |
|
pure virtual |
Integrates the depth-integrated field over a circle.
| [in] | x | North position of the circle centre [m]. |
| [in] | y | East position of the circle centre [m]. |
| [in] | radius | Circle radius [m]. |
|
pure virtual |
Integrates the field over a horizontal disk.
| [in] | x | North position of the disk centre [m]. |
| [in] | y | East position of the disk centre [m]. |
| [in] | z | Depth of the disk plane, positive down [m]. |
| [in] | radius | Disk radius [m]. |
|
pure virtual |
Integrates the depth-integrated field over an axis-aligned rectangle.
| [in] | xMin | Southern edge [m]. |
| [in] | xMax | Northern edge [m]. |
| [in] | yMin | Western edge [m]. |
| [in] | yMax | Eastern edge [m]. |