EnvironmentalData Struct Reference
Environment data across time and space. This is useful to introduce physical quantities that may be of interest even if not modelled in simulation. More...
#include <Environment.hh>
Public Types | |
| using | FrameT = common::DataFrame< std::string, T > |
| using | ReferenceT = math::SphericalCoordinates::CoordinateType |
| enum | ReferenceUnits { RADIANS = 0, DEGREES } |
| Reference units. More... | |
| using | T = math::InMemoryTimeVaryingVolumetricGrid< double > |
Static Public Member Functions | |
| static std::shared_ptr< EnvironmentalData > | MakeShared (FrameT _frame, ReferenceT _reference, ReferenceUnits _units=ReferenceUnits::RADIANS, bool _ignoreTimeStep=false) |
| Instantiate environmental data. More... | |
Public Attributes | |
| FrameT | frame |
| Environmental data frame. More... | |
| ReferenceT | reference |
| Spatial reference for data coordinates. More... | |
| bool | staticTime |
| Use time axis or not. More... | |
| ReferenceUnits | units |
| The units to be used (only for spherical coordinates) More... | |
Detailed Description
Environment data across time and space. This is useful to introduce physical quantities that may be of interest even if not modelled in simulation.
Member Typedef Documentation
◆ FrameT
| using FrameT = common::DataFrame<std::string, T> |
◆ ReferenceT
◆ T
| using T = math::InMemoryTimeVaryingVolumetricGrid<double> |
Member Enumeration Documentation
◆ ReferenceUnits
|
strong |
Member Function Documentation
◆ MakeShared()
|
static |
Instantiate environmental data.
An std::make_shared equivalent that ensures dynamically loaded call sites use a template instantiation that is guaranteed to outlive them.
Member Data Documentation
◆ frame
| FrameT frame |
Environmental data frame.
◆ reference
| ReferenceT reference |
Spatial reference for data coordinates.
◆ staticTime
| bool staticTime |
Use time axis or not.
◆ units
| ReferenceUnits units |
The units to be used (only for spherical coordinates)
The documentation for this struct was generated from the following file: