Public Attributes | |
| int | debug_level |
| int | stream |
| CoordZ | tx_coordz |
| CoordZ | rx_coordz |
| double | frequency |
| string | db_path |
| string | bathy_db_file_path |
| string | ssp_db_file_path |
| string | res_path |
| string | custom_ssp |
| string | custom_bathy |
| string | custom_sedim |
Private Member Functions | |
| virtual void | doConfig () override |
| virtual void | doInit () override |
| virtual void | doRun () override |
Additional Inherited Members | |
 Protected Member Functions inherited from woss::WossTest | |
| void | config () |
| void | init () |
| Protected Attributes inherited from woss::WossTest | |
| bool | debug |
| debug flag | |
| std::unique_ptr< SSP > | ssp_proto |
| SSP prototype which will be plugged into the WOSS framework. | |
| std::unique_ptr< Sediment > | sediment_proto |
| Sediment prototype which will be plugged into the WOSS framework. | |
| std::unique_ptr< Pressure > | pressure_proto |
| Pressure prototype which will be plugged into the WOSS framework. | |
| std::unique_ptr< TimeArr > | time_arr_proto |
| TimeArr prototype which will be plugged into the WOSS framework. | |
| std::unique_ptr< Transducer > | transducer_proto |
| Transducer prototype which will be plugged into the WOSS framework. | |
| std::unique_ptr< AltimBretschneider > | altim_bret_proto |
| AltimBretschneider prototype which will be plugged into the WOSS framework. | |
| std::unique_ptr< Location > | location_proto |
| Location prototype which will be plugged into the WOSS framework. | |
| int | woss_random_gen_stream |
| random generator used by the WOSS framework. | |
| std::unique_ptr< RandomGenerator > | random_gen_proto |
| RandomGenerator prototype which will be plugged into the WOSS framework. | |
| std::unique_ptr< TimeReference > | time_ref_proto |
| TimeReference prototype which will be plugged into the WOSS framework. | |
| DefHandler & | def_handler |
| Definition Handler object allocated by the helper. | |
| bool | res_db_creator_debug |
| enable/disable the debug prints of the woss results database creator. | |
| bool | res_db_debug |
| enable/disable the debug prints of the woss result databases. | |
| bool | res_db_use_binary |
| set up the woss result database format: binary or textual. | |
| bool | res_db_use_time_arr |
| set up the woss result databases data format: power delay profile. | |
| bool | res_db_use_pressure |
| set up the woss result databases data format: single pressure tap. | |
| double | res_db_space_sampling |
| set up the woss result database 2D spatial sampling | |
| std::string | res_db_file_path |
| set up the woss result database file path | |
| std::string | res_db_file_name |
| set up the woss result database file name (without path) | |
| std::shared_ptr< ResPressureBinDbCreator > | res_db_creator_press_bin |
| the helper will automatically allocate the desired result database creator based on current configuration. | |
| std::shared_ptr< ResPressureTxtDbCreator > | res_db_creator_press_txt |
| the helper will automatically allocate the desired result database creator based on current configuration. | |
| std::shared_ptr< ResTimeArrBinDbCreator > | res_db_creator_time_arr_bin |
| the helper will automatically allocate the desired result database creator based on current configuration. | |
| std::shared_ptr< ResTimeArrTxtDbCreator > | res_db_creator_time_arr_txt |
| the helper will automatically allocate the desired result database creator based on current configuration. | |
| DECK41DbType | sedim_deck41_db_type |
| DECK41 db data format type. | |
| bool | sedim_db_creator_debug |
| enable/disable the debug prints of the woss sediment database creator. | |
| bool | sedim_db_debug |
| enable/disable the debug prints of the woss sediment database. | |
| std::string | sedim_db_coord_file_path |
| setup the path of the sediment database indexed by geographical coordinates with decimal degrees resolution | |
| std::string | sedim_db_marsden_file_path |
| setup the path of the sediment database indexed by geographical coordinates with marsden square resolution | |
| std::string | sedim_db_marsden_one_file_path |
| setup the path of the sediment database indexed by geographical coordinates with marsden one square resolution | |
| std::shared_ptr< SedimDeck41DbCreator > | sedim_db_creator |
| the helper will automatically allocate the woss sediment database creator | |
| bool | ssp_db_creator_debug |
| enable/disable the debug prints of the woss SSP database creator. | |
| bool | ssp_db_debug |
| enable/disable the debug prints of the woss SSP database. | |
| std::string | ssp_db_file_path |
| setup the path of the woss monthly SSP database indexed by geographical coordinates | |
| WOADbType | ssp_woa_db_type |
| WOA SSP Db Type. | |
| std::shared_ptr< SspWoa2005DbCreator > | ssp_db_creator |
| the helper will automatically allocate the woss sediment database creator | |
| bool | bathy_db_creator_debug |
| enable/disable the debug prints of the woss Bathymetry database creator. | |
| bool | bathy_db_debug |
| enable/disable the debug prints of the woss Bathymetry database (GEBCO). | |
| GEBCO_BATHY_TYPE | bathy_db_gebco_format |
| setup the the GEBCO database format | |
| std::string | bathy_db_file_path |
| setup the path of the woss GEBCO database | |
| std::shared_ptr< BathyGebcoDbCreator > | bathy_db_creator |
| the helper will automatically allocate the woss GEBCO bathymetry db creator | |
| bool | woss_db_manager_debug |
| enable/disable the debug prints of the woss DB manager object. | |
| std::shared_ptr< WossDbManager > | woss_db_manager |
| the helper will automatically allocate the woss DB manager | |
| bool | woss_creator_debug |
| enable/disable the debug prints of the woss creator. | |
| bool | woss_debug |
| enable/disable the debug prints of all woss objects | |
| bool | woss_clear_work_dir |
| woss object configuration: clear the temporary files created by the underlying channel simulator | |
| double | evolution_time_quantum |
| woss object configuration: evolution time quantum | |
| int | total_runs |
| woss object configuration: total number of channel simulator runs | |
| double | frequency_step |
| woss object configuration: number of frequency steps | |
| double | total_range_steps |
| woss object configuration: tx - rx range sampling in meters | |
| double | tx_min_depth_offset |
| woss object configuration: transmitter min offset in meters | |
| double | tx_max_depth_offset |
| woss object configuration: transmitter max offset in meters | |
| int | total_transmitters |
| woss object configuration: total number of transmitting sources | |
| int | total_rx_depths |
| woss object configuration: receiver depth sampling | |
| double | rx_min_depth_offset |
| woss object configuration: receiver min depth offset in meters | |
| double | rx_max_depth_offset |
| woss object configuration: receiver max depth offset in meters | |
| int | total_rx_ranges |
| woss object configuration: receiver range sampling | |
| double | rx_min_range_offset |
| woss object configuration: receiver min range offset in meters | |
| double | rx_max_range_offset |
| woss object configuration: receiver max range offset in meters | |
| double | total_rays |
| woss object configuration: total number of rays (0 = automatic) | |
| double | min_angle |
| woss object configuration: minimum vertical angle in decimal degrees | |
| double | max_angle |
| woss object configuration: maximum vertical angle in decimal degrees | |
| bool | use_thorpe_att |
| woss object configuration: use thorpe attenuation in channel computation | |
| double | ssp_depth_precision |
| woss object configuration: SSP depth precision in meters | |
| double | normalized_ssp_depth_steps |
| woss object configuration: SSP depth quantization steps | |
| std::string | work_dir_path |
| woss object configuration: path of the temporary directory | |
| std::string | bellhop_path |
| woss object configuration: path of the Bellhop executable | |
| std::string | bellhop_mode |
| woss object configuration: Bellhop mode string | |
| std::string | bellhop_beam_options |
| woss object configuration: Bellhop beam option string | |
| std::string | bellhop_bathy_type |
| woss object configuration: Bellhop bathymetry type string | |
| std::string | bellhop_bathy_method |
| woss object configuration: Bathymetry write method string | |
| std::string | bellhop_altim_type |
| woss object configuration: Bellhop Altimetry type string | |
| BellhopArrSyntax | bellhop_arr_syntax |
| woss object configration: Bellhop Arr file syntax to be used during .arr file parsing | |
| BellhopShdSyntax | bellhop_shd_syntax |
| woss object configration: Bellhop Shd file syntax to be used during .shd file parsing | |
| SimTime | sim_time |
| woss object configuration: woss simulation times (start and end sim times) | |
| std::shared_ptr< BellhopCreator > | bellhop_creator |
| the helper will automatically allocate the woss creator | |
| double | box_depth |
| woss object configuration: maximum depth to trace rays to; deeper rays will be ignored | |
| double | box_range |
| woss object configuration: maximum range to trace rats to; longer rays will be ignored | |
| bool | woss_manager_debug |
| enable/disable the debug prints of the woss manager. | |
| bool | time_evolution_active |
| enable/disable the time evolution feature. | |
| unsigned int | concurrent_threads |
| number of concurrent threads (0 = auto). | |
| double | woss_manager_space_sampling |
| woss manager space sampling in meters | |
| bool | woss_manager_use_multithread |
| enable/disable the multithread feature | |
| bool | woss_manager_use_thread_pool |
| enable/disable woss::ThreadPool usage | |
| std::shared_ptr< WossManagerSimple< WossManagerResDb > > | woss_manager_simple |
| the helper will automatically allocate the desired woss manager based on current configuration. | |
| std::shared_ptr< WossManagerSimple< WossManagerResDbMT > > | woss_manager_multi |
| the helper will automatically allocate the desired woss manaeger based on current configuration. | |
| bool | woss_transducer_handler_debug |
| enable/disable the debug prints of the woss transducer handler. | |
| std::shared_ptr< TransducerHandler > | woss_transducer_handler |
| the helper will automatically allocate the woss Transducer handler. | |
| bool | woss_controller_debug |
| enable/disable the debug prints of the woss conteroller | |
| std::shared_ptr< WossController > | woss_controller |
| the helper will automatically allocate the woss controller. | |
| bool | initialized |
| initialization complete flag. | |
Constructor & Destructor Documentation
◆ WossBellhopScript()
| WossBellhopScript::WossBellhopScript | ( | ) |
◆ ~WossBellhopScript()
|
virtualdefault |
Member Function Documentation
◆ doConfig()
|
overrideprivatevirtual |
Virtual function that allows the derived class to perform its custom configuration phase
valid for 2001 2013, 2018 and 2023 WOA SSP NetCDF db files
valid for latest GEBCO db files (>= 2021)
Implements woss::WossTest.
References bathy_db_file_path, custom_bathy, custom_sedim, custom_ssp, db_path, debug_level, res_path, woss::WossTest::setBathyDbFilePath(), woss::WossTest::setBathyDbGebcoFormat(), woss::WossTest::setResDbCreatorDebug(), woss::WossTest::setResDbDebug(), woss::WossTest::setResDbFileName(), woss::WossTest::setResDbFilePath(), woss::WossTest::setResDbUseBinary(), woss::WossTest::setResDbUsePressure(), woss::WossTest::setResDbUseTimeArr(), woss::WossTest::setSedimDbCoordFilePath(), woss::WossTest::setSedimDbMarsdenFilePath(), woss::WossTest::setSedimDbMarsdenOneFilePath(), woss::WossTest::setSedimDeck41DbType(), woss::WossTest::setSspDbFilePath(), woss::WossTest::setSspWoaDbType(), woss::WossTest::setWossBellhopAltimType(), woss::WossTest::setWossBellhopArraySyntax(), woss::WossTest::setWossBellhopBathyMethod(), woss::WossTest::setWossBellhopBathyType(), woss::WossTest::setWossBellhopBeamOptions(), woss::WossTest::setWossBellhopMode(), woss::WossTest::setWossBellhopShdSyntax(), woss::WossTest::setWossBoxDepth(), woss::WossTest::setWossBoxRange(), woss::WossTest::setWossClearWorkDir(), woss::WossTest::setWossCreatorDebug(), woss::WossTest::setWossDbManagerDebug(), woss::WossTest::setWossDebug(), woss::WossTest::setWossEvolutionTimeQuantum(), woss::WossTest::setWossFrequencyStep(), woss::WossTest::setWossManagerDebug(), woss::WossTest::setWossManagerSpaceSampling(), woss::WossTest::setWossManagerThreads(), woss::WossTest::setWossManagerTimeEvoActive(), woss::WossTest::setWossManagerUseMultiThread(), woss::WossTest::setWossMaxAngle(), woss::WossTest::setWossMinAngle(), woss::WossTest::setWossNormalizedSspDepthSteps(), woss::WossTest::setWossRandomGenStream(), woss::WossTest::setWossRxMaxDepthOffset(), woss::WossTest::setWossRxMaxRangeOffset(), woss::WossTest::setWossRxMinDepthOffset(), woss::WossTest::setWossRxMinRangeOffset(), woss::WossTest::setWossSimTime(), woss::WossTest::setWossSspDepthPrecision(), woss::WossTest::setWossTotalRangeSteps(), woss::WossTest::setWossTotalRays(), woss::WossTest::setWossTotalRuns(), woss::WossTest::setWossTotalRxDepths(), woss::WossTest::setWossTotalRxRanges(), woss::WossTest::setWossTotalTransmitters(), woss::WossTest::setWossTxMaxDepthOffset(), woss::WossTest::setWossTxMinDepthOffset(), woss::WossTest::setWossUseThorpeAtt(), woss::WossTest::setWossWorkDirPath(), ssp_db_file_path, and stream.
◆ doInit()
|
overrideprivatevirtual |
Virtual function that allows the derived class to perform its custom initialization phase
Implements woss::WossTest.
References custom_bathy, custom_sedim, custom_ssp, db_path, frequency, woss::CoordZ::isValid(), rx_coordz, tx_coordz, and woss::WossTest::woss_db_manager.
◆ doRun()
|
overrideprivatevirtual |
Virtual function that allows the derived class to perform its custom run phase
Implements woss::WossTest.
References woss::WossTest::bellhop_creator, woss::WossTest::debug, frequency, woss::Singleton< T >::instance(), res_path, rx_coordz, tx_coordz, and woss::WossTest::woss_controller.
Member Data Documentation
◆ bathy_db_file_path
| string WossBellhopScript::bathy_db_file_path |
subpath to the bathymetry NetCDF db
Referenced by doConfig(), and main().
◆ custom_bathy
| string WossBellhopScript::custom_bathy |
string representing a custom bathymetry line. Syntax: "tot_ranges|range1[m]|depth1[m]|....|rangeN[m]|depthN[m]"
Referenced by doConfig(), doInit(), and main().
◆ custom_sedim
| string WossBellhopScript::custom_sedim |
string representing a custom sediment. Syntax: "SedimName|vel_comp[m/s]|vel_shear[m/s]|dens[g/cm3]|atten_comp[db/wavelength]|atten_shear[db/wavelength]|bottom depth[m]"
Referenced by doConfig(), doInit(), and main().
◆ custom_ssp
| string WossBellhopScript::custom_ssp |
string representing a custom SSP. Syntax: "tot_depths|depth1[m]|speed1[m/s]|...|depthN[m]|speedN[m/s]"
Referenced by doConfig(), doInit(), and main().
◆ db_path
| string WossBellhopScript::db_path |
path to the WOSS db directories
Referenced by doConfig(), doInit(), and main().
◆ debug_level
| int WossBellhopScript::debug_level |
debug level 0 = no debug prints
0 enable test script debug log 10 enable main woss debug logs 100 enable all woss debug logs
Referenced by doConfig(), and main().
◆ frequency
| double WossBellhopScript::frequency |
◆ res_path
| string WossBellhopScript::res_path |
path where the channel results will be written to
Referenced by doConfig(), doRun(), and main().
◆ rx_coordz
| CoordZ WossBellhopScript::rx_coordz |
◆ ssp_db_file_path
| string WossBellhopScript::ssp_db_file_path |
subpath to the SSP NetCDF db
Referenced by doConfig(), and main().
◆ stream
| int WossBellhopScript::stream |
WOSS random simulator seed
Referenced by doConfig(), and main().
◆ tx_coordz
| CoordZ WossBellhopScript::tx_coordz |
The documentation for this class was generated from the following file:
- tests/woss-bellhop-script.cpp
