FhSim  3.1.0
Marine systems simulation
Loading...
Searching...
No Matches
parameters.h
1#pragma once
2
11#include "marenv/seafloor/BathymetryWaves.h"
12#include "marenv/wave/WaveEnergySpectrum.h"
13#include "seafloorForces/SeafloorForces.h"
14#include <string>
15#include <vector>
16#include <memory>
17
18#include <fhsim/simobject/ISimObjectCreator.h>
19#include <fhsim_environment/ScalarField.h>
20#include <marenv/current/CurrentField.h>
21#include <marenv/wave/WaveComponents.h>
22
24namespace util
25{
33marenv::wave::WaveEnergySpectrum::SpectrumParameters GetSpectrumParameters(ISimObjectCreator* creator, const std::string& prefix, marenv::wave::SpectrumType specType);
34
42std::shared_ptr<marenv::wave::WaveField> GetWaves(ISimObjectCreator* creator, const std::string& prefix, int randomSeed);
43
54std::shared_ptr<marenv::seafloor::BathymetryWaves> GetBathymetryWaves(ISimObjectCreator* creator, int randomSeed);
55
70std::shared_ptr<marenv::seafloor::BathymetryField> GetBathymetry(
71 ISimObjectCreator* creator,
72 int randomSeed,
73 std::shared_ptr<marenv::seafloor::BathymetryWaves> sumOfSines);
74
87std::shared_ptr<marenv::current::CurrentField> GetCurrents(ISimObjectCreator* creator);
88
116std::vector<std::shared_ptr<environment::field::ScalarField>> GetScalarFields(ISimObjectCreator* creator,
117 std::shared_ptr<marenv::seafloor::BathymetryField> seafloor);
118
128std::shared_ptr<environment::SeafloorForces> GetSeafloorForces(ISimObjectCreator* creator, std::shared_ptr<marenv::seafloor::BathymetryField> bathymetry);
129
130} // 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:43