environment::EnvironmentConfig Struct Reference

#include <EnvironmentConfig.h>

Public Member Functions
	EnvironmentConfig (ISimObjectCreator *creator)

Public Attributes
int	randomSeed = 1
	Random seed (RandomSeed, default 1): decides the wave-component phases and the sum-of-sines seabed.
std::shared_ptr< marenv::wave::WaveField >	waves
	Wave field.
std::shared_ptr< marenv::seafloor::BathymetryWaves >	bathymetry
	Sum-of-sines bathymetry (also the seabed for the "SumOfSines" model, and the GPU seabed of the visuals).
std::shared_ptr< marenv::seafloor::BathymetryField >	seafloor
	Active seabed used for physics queries (may be sum-of-sines or another model).
std::shared_ptr< marenv::current::CurrentField >	currents
	Current field.
std::vector< std::shared_ptr< environment::field::ScalarField > >	scalarFields
	Named scalar fields (temperature, salinity, species concentration). Empty when none are configured.
std::shared_ptr< environment::SeafloorForces >	seafloorForces
	Seafloor forces.

Detailed Description

The waves, seabed, currents, scalar fields and seafloor forces of the Environment, built from the input file.

Reads no Visual.* parameter, so a headless run neither reads nor checks them. The visual settings (visual::VisualSettings) are built from this and share its fields.

Constructor & Destructor Documentation

EnvironmentConfig()

environment::EnvironmentConfig::EnvironmentConfig ( ISimObjectCreator *  creator )

explicit

Read the physics parameters, in the order RandomSeed, Waves.*, Bathymetry.*, Current.*, ScalarField.*, SeafloorForces.*.

Parameters

[in]

creator

Pointer to object creator.

Exceptions

std::runtime_error

(after a parameter error) for an invalid parameter.

---

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

• webfhsim/reloadrepos/fhsim_environment/src/environment/util/EnvironmentConfig.h