FhSim  3.1.0
Marine systems simulation
Loading...
Searching...
No Matches
parameters.h
1#pragma once
2
8#include "marenv/seafloor/BathymetryWaves.h"
9#include "marenv/wave/WaveEnergySpectrum.h"
10#include "seafloorForces/SeafloorForces.h"
11
12#include <fhsim/simobject/ISimObjectCreator.h>
13#include <fhsim_environment/ScalarField.h>
14#include <marenv/current/CurrentField.h>
15#include <marenv/wave/WaveComponents.h>
16
18namespace util
19{
27marenv::wave::WaveEnergySpectrum::SpectrumParameters GetSpectrumParameters(ISimObjectCreator* creator, const std::string& prefix, marenv::wave::SpectrumType specType);
28
36std::shared_ptr<marenv::wave::WaveField> GetWaves(ISimObjectCreator* creator, const std::string& prefix, int randomSeed);
37
48std::shared_ptr<marenv::seafloor::BathymetryWaves> GetBathymetryWaves(ISimObjectCreator* creator, int randomSeed);
49
62std::shared_ptr<marenv::seafloor::BathymetryField> GetBathymetry(
63 ISimObjectCreator* creator,
64 int randomSeed,
65 std::shared_ptr<marenv::seafloor::BathymetryWaves> sumOfSines);
66
79std::shared_ptr<marenv::current::CurrentField> GetCurrents(ISimObjectCreator* creator);
80
107std::vector<std::shared_ptr<environment::field::ScalarField>> GetScalarFields(ISimObjectCreator* creator,
108 std::shared_ptr<marenv::seafloor::BathymetryField> seafloor);
109
119std::shared_ptr<environment::SeafloorForces> GetSeafloorForces(ISimObjectCreator* creator, std::shared_ptr<marenv::seafloor::BathymetryField> bathymetry);
120
121} // namespace util
Utility functions for reading Environment parameters from XML.
Definition BathymetryDiagnostics.h:16
std::shared_ptr< environment::SeafloorForces > GetSeafloorForces(ISimObjectCreator *creator, std::shared_ptr< marenv::seafloor::BathymetryField > bathymetry)
std::shared_ptr< marenv::seafloor::BathymetryField > GetBathymetry(ISimObjectCreator *creator, int randomSeed, std::shared_ptr< marenv::seafloor::BathymetryWaves > sumOfSines)
std::shared_ptr< marenv::seafloor::BathymetryWaves > GetBathymetryWaves(ISimObjectCreator *creator, int randomSeed)
marenv::wave::WaveEnergySpectrum::SpectrumParameters GetSpectrumParameters(ISimObjectCreator *creator, const std::string &prefix, marenv::wave::SpectrumType specType)
std::shared_ptr< marenv::wave::WaveField > GetWaves(ISimObjectCreator *creator, const std::string &prefix, int randomSeed)
std::vector< std::shared_ptr< environment::field::ScalarField > > GetScalarFields(ISimObjectCreator *creator, std::shared_ptr< marenv::seafloor::BathymetryField > seafloor)
std::shared_ptr< marenv::current::CurrentField > GetCurrents(ISimObjectCreator *creator)
The parameters defining a certain wave field.
Definition WaveEnergySpectrum.h:41