Code documentation

• Client
  • main()
• Server
  • json
  • exec()
  • exitSimulationThread()
  • checkSimThreadActive()
  • canRunThread()
  • updateData()
  • main()
  • m_PORT
  • m_EXIT
  • simulator
  • m_simulationThread
  • m_updateThread
  • m_stopUpdating
  • m_isSimulationRunning
  • m_lastDataUpdate
  • m_dataUpdateFrequency
  • l_systemInfo
  • l_usedRAM
  • l_totalRAM
  • l_cpuUsage
• Simulator
  • Simulator
    • Simulator::isPreparing()
    • Simulator::isCalculating()
    • Simulator::isResetting()
    • Simulator::getWaveProp()
    • Simulator::getSetupChoice()
    • Simulator::getTimeValues()
    • Simulator::getCellAmount()
    • Simulator::getSimulationSize()
    • Simulator::getSimulationOffset()
    • Simulator::setSetupChoice()
    • Simulator::setCellAmount()
    • Simulator::setOffset()
    • Simulator::setBathymetryFilePath()
    • Simulator::setDisplacementFilePath()
    • Simulator::setPrepared()
    • Simulator::~Simulator()
    • Simulator::deleteCheckpoints()
    • Simulator::deleteStations()
    • Simulator::resetSimulator()
    • Simulator::writeCheckpoint()
    • Simulator::loadConfigDataFromFile()
    • Simulator::loadConfigDataJson()
    • Simulator::loadStations()
    • Simulator::addStation()
    • Simulator::prepareForCalculation()
    • Simulator::runCalculation()
    • Simulator::toggleFileIO()
    • Simulator::start()
    • Simulator::shouldExit()
    • Simulator::setPausingStatus()
    • Simulator::computeEstimatedTimeLeft()
    • Simulator::m_calculationTime
    • Simulator::m_preparingTime
    • Simulator::m_timePerTimeStep
• Calculations
  • calculations
    • calculations::Froude
      • calculations::Froude::getMaxFroude()
      • calculations::Froude::getFroude()
      • calculations::Froude::m_g
• I/O
  • io
    • io::BathymetryLoader
      • io::BathymetryLoader::~BathymetryLoader()
      • io::BathymetryLoader::loadBathymetry()
      • io::BathymetryLoader::getBathymetry()
      • io::BathymetryLoader::m_b
      • io::BathymetryLoader::m_sizeX
      • io::BathymetryLoader::m_sizeY
    • io::Csv
      • io::Csv::write()
      • io::Csv::splitLine()
    • io::Logger
      • io::Logger::Logger()
      • io::Logger::log()
      • io::Logger::logError()
      • io::Logger::logWarning()
      • io::Logger::clear()
      • io::Logger::getLog()
      • io::Logger::getLastLine()
      • io::Logger::m_data
      • io::Logger::m_lastLine
    • io::NetCdf
      • io::NetCdf::NetCdf()
      • io::NetCdf::NetCdf()
      • io::NetCdf::~NetCdf()
      • io::NetCdf::write()
      • io::NetCdf::writeCheckpoint()
      • io::NetCdf::loadCheckpointDimensions()
      • io::NetCdf::flush()
      • io::NetCdf::getDimensionSize()
      • io::NetCdf::read()
      • io::NetCdf::read()
      • io::NetCdf::setUpFile()
      • io::NetCdf::setUpCheckpointFile()
      • io::NetCdf::loadNetCdfIds()
      • io::NetCdf::m_nx
      • io::NetCdf::m_ny
      • io::NetCdf::m_simulationSizeX
      • io::NetCdf::m_simulationSizeY
      • io::NetCdf::m_offsetX
      • io::NetCdf::m_offsetY
      • io::NetCdf::m_err
      • io::NetCdf::m_k
      • io::NetCdf::m_nkx
      • io::NetCdf::m_nky
      • io::NetCdf::m_netcdfOutputFile
      • io::NetCdf::m_checkpointFile
      • io::NetCdf::m_hasCheckpointFileBeenSetup
      • io::NetCdf::m_doesSolutionExist
      • io::NetCdf::m_ncId
      • io::NetCdf::m_dimXId
      • io::NetCdf::m_dimYId
      • io::NetCdf::m_dimTId
      • io::NetCdf::m_varXId
      • io::NetCdf::m_varYId
      • io::NetCdf::m_varTId
      • io::NetCdf::m_varHId
      • io::NetCdf::m_varTHId
      • io::NetCdf::m_varBId
      • io::NetCdf::m_varHuId
      • io::NetCdf::m_varHvId
      • io::NetCdf::m_ncCheckId
      • io::NetCdf::m_dimCheckXId
      • io::NetCdf::m_dimCheckYId
      • io::NetCdf::m_dimCheckTId
      • io::NetCdf::m_varCheckXId
      • io::NetCdf::m_varCheckYId
      • io::NetCdf::m_varCheckTId
      • io::NetCdf::m_varCheckHId
      • io::NetCdf::m_varCheckHuId
      • io::NetCdf::m_varCheckHvId
      • io::NetCdf::m_varCheckBId
      • io::NetCdf::m_varCheckTimeStepId
      • io::NetCdf::m_varCheckWritingStepsCountId
      • io::NetCdf::m_varCheckSimSizeXId
      • io::NetCdf::m_varCheckSimSizeYId
      • io::NetCdf::m_varCheckOffsetXId
      • io::NetCdf::m_varCheckOffsetYId
      • io::NetCdf::m_varCheckKId
      • io::NetCdf::m_writingStepsCount
      • io::NetCdf::m_outputFileOpened
    • io::Station
      • io::Station::Station()
      • io::Station::~Station()
      • io::Station::capture()
      • io::Station::write()
      • io::Station::getData()
      • io::Station::setWaveProp()
      • io::Station::m_x
      • io::Station::m_y
      • io::Station::m_stride
      • io::Station::m_name
      • io::Station::m_waveProp
      • io::Station::m_filepath
      • io::Station::m_data
• lib
  • xlpmg
    • xlpmg::MessagePart
      • xlpmg::MessagePart::EXPECTATION
      • xlpmg::MessagePart::URGENCY
      • xlpmg::MessagePart::KEY
      • xlpmg::MessagePart::ARGS
    • xlpmg::MessageExpectation
      • xlpmg::MessageExpectation::NO_RESPONSE
      • xlpmg::MessageExpectation::EXPECT_RESPONSE
    • xlpmg::MessageUrgency
      • xlpmg::MessageUrgency::CRITICAL
      • xlpmg::MessageUrgency::HIGH
      • xlpmg::MessageUrgency::MEDIUM
      • xlpmg::MessageUrgency::LOW
    • xlpmg::messageToJson()
    • xlpmg::messageToJsonString()
    • xlpmg::jsonToMessage()
    • xlpmg::KILL_SIMULATION
    • xlpmg::WRITE_CHECKPOINT
    • xlpmg::PAUSE_SIMULATION
    • xlpmg::SHUTDOWN_SERVER
    • xlpmg::CHECK
    • xlpmg::START_SIMULATION
    • xlpmg::CONTINUE_SIMULATION
    • xlpmg::RESET_SIMULATOR
    • xlpmg::TOGGLE_FILEIO
    • xlpmg::COMPILE
    • xlpmg::COMPILE_RUN_BASH
    • xlpmg::COMPILE_RUN_SBATCH
    • xlpmg::DELETE_CHECKPOINTS
    • xlpmg::DELETE_STATIONS
    • xlpmg::SET_OFFSET
    • xlpmg::SET_CELL_AMOUNT
    • xlpmg::SEND_FILE
    • xlpmg::LOAD_CONFIG_JSON
    • xlpmg::LOAD_CONFIG_FILE
    • xlpmg::SET_READ_BUFFER_SIZE
    • xlpmg::SET_SEND_BUFFER_SIZE
    • xlpmg::LOAD_STATIONS
    • xlpmg::GET_TIME_VALUES
    • xlpmg::GET_SYSTEM_INFORMATION
    • xlpmg::GET_SIMULATION_SIZES
    • xlpmg::GET_HEIGHT_DATA
    • xlpmg::GET_BATHYMETRY_DATA
    • xlpmg::RECV_FILE
    • xlpmg::BUFFERED_SEND_FINISHED
    • xlpmg::SERVER_RESPONSE
    • xlpmg::Message
      • xlpmg::Message::expectation
      • xlpmg::Message::urgency
      • xlpmg::Message::key
      • xlpmg::Message::args
    • Communicator
      • Communicator::setReadBufferSize()
      • Communicator::setSendBufferSize()
      • Communicator::startClient()
      • Communicator::stopClient()
      • Communicator::receiveFromServer()
      • Communicator::sendToServer()
      • Communicator::getLog()
      • Communicator::clearLog()
      • Communicator::startServer()
      • Communicator::stopServer()
      • Communicator::receiveFromClient()
      • Communicator::sendToClient()
      • Communicator::BUFF_SIZE_READ_DEFAULT
      • Communicator::BUFF_SIZE_READ
      • Communicator::BUFF_SIZE_SEND_DEFAULT
      • Communicator::BUFF_SIZE_SEND
      • Communicator::isConnected
      • Communicator::TIMEOUT
• Patches
  • patches
    • patches::WavePropagation
      • patches::WavePropagation::Boundary
        • patches::WavePropagation::Boundary::OUTFLOW
        • patches::WavePropagation::Boundary::WALL
      • patches::WavePropagation::~WavePropagation()
      • patches::WavePropagation::timeStep()
      • patches::WavePropagation::setGhostOutflow()
      • patches::WavePropagation::getStride()
      • patches::WavePropagation::getHeight()
      • patches::WavePropagation::getMomentumX()
      • patches::WavePropagation::getMomentumY()
      • patches::WavePropagation::getBathymetry()
      • patches::WavePropagation::setHeight()
      • patches::WavePropagation::setMomentumX()
      • patches::WavePropagation::setMomentumY()
      • patches::WavePropagation::setBathymetry()
      • patches::WavePropagation::adjustWaterHeight()
    • patches::WavePropagation1d
      • patches::WavePropagation1d::WavePropagation1d()
      • patches::WavePropagation1d::~WavePropagation1d()
      • patches::WavePropagation1d::timeStep()
      • patches::WavePropagation1d::setGhostOutflow()
      • patches::WavePropagation1d::getStride()
      • patches::WavePropagation1d::getHeight()
      • patches::WavePropagation1d::getMomentumX()
      • patches::WavePropagation1d::getMomentumY()
      • patches::WavePropagation1d::getBathymetry()
      • patches::WavePropagation1d::setHeight()
      • patches::WavePropagation1d::setMomentumX()
      • patches::WavePropagation1d::setMomentumY()
      • patches::WavePropagation1d::setBathymetry()
      • patches::WavePropagation1d::adjustWaterHeight()
      • patches::WavePropagation1d::handleReflections()
      • patches::WavePropagation1d::m_step
      • patches::WavePropagation1d::m_nCells
      • patches::WavePropagation1d::m_h
      • patches::WavePropagation1d::m_hu
      • patches::WavePropagation1d::m_b
      • patches::WavePropagation1d::m_solver
      • patches::WavePropagation1d::m_boundaryL
      • patches::WavePropagation1d::m_boundaryR
    • patches::WavePropagation2d
      • patches::WavePropagation2d::WavePropagation2d()
      • patches::WavePropagation2d::~WavePropagation2d()
      • patches::WavePropagation2d::timeStep()
      • patches::WavePropagation2d::setGhostOutflow()
      • patches::WavePropagation2d::getStride()
      • patches::WavePropagation2d::getHeight()
      • patches::WavePropagation2d::getMomentumX()
      • patches::WavePropagation2d::getMomentumY()
      • patches::WavePropagation2d::getBathymetry()
      • patches::WavePropagation2d::setHeight()
      • patches::WavePropagation2d::setMomentumX()
      • patches::WavePropagation2d::setMomentumY()
      • patches::WavePropagation2d::setBathymetry()
      • patches::WavePropagation2d::adjustWaterHeight()
      • patches::WavePropagation2d::handleReflections()
      • patches::WavePropagation2d::m_step
      • patches::WavePropagation2d::m_nCellsX
      • patches::WavePropagation2d::m_nCellsY
      • patches::WavePropagation2d::m_h
      • patches::WavePropagation2d::m_huX
      • patches::WavePropagation2d::m_huY
      • patches::WavePropagation2d::m_b
      • patches::WavePropagation2d::m_boundaryL
      • patches::WavePropagation2d::m_boundaryR
      • patches::WavePropagation2d::m_boundaryT
      • patches::WavePropagation2d::m_boundaryB
• Setups
  • setups
    • setups::ArtificialTsunami2d
      • setups::ArtificialTsunami2d::ArtificialTsunami2d()
      • setups::ArtificialTsunami2d::computeD()
      • setups::ArtificialTsunami2d::computeF()
      • setups::ArtificialTsunami2d::computeG()
      • setups::ArtificialTsunami2d::getHeight()
      • setups::ArtificialTsunami2d::getMomentumX()
      • setups::ArtificialTsunami2d::getMomentumY()
      • setups::ArtificialTsunami2d::getBathymetry()
      • setups::ArtificialTsunami2d::m_pi
    • setups::CircularDamBreak2d
      • setups::CircularDamBreak2d::CircularDamBreak2d()
      • setups::CircularDamBreak2d::getHeight()
      • setups::CircularDamBreak2d::getMomentumX()
      • setups::CircularDamBreak2d::getMomentumY()
      • setups::CircularDamBreak2d::getBathymetry()
      • setups::CircularDamBreak2d::m_height
      • setups::CircularDamBreak2d::m_radius
      • setups::CircularDamBreak2d::m_baseHeight
    • setups::DamBreak1d
      • setups::DamBreak1d::DamBreak1d()
      • setups::DamBreak1d::getHeight()
      • setups::DamBreak1d::getMomentumX()
      • setups::DamBreak1d::getMomentumY()
      • setups::DamBreak1d::getBathymetry()
      • setups::DamBreak1d::m_heightLeft
      • setups::DamBreak1d::m_heightRight
      • setups::DamBreak1d::m_locationDam
    • setups::GeneralDiscontinuity1d
      • setups::GeneralDiscontinuity1d::GeneralDiscontinuity1d()
      • setups::GeneralDiscontinuity1d::getHeight()
      • setups::GeneralDiscontinuity1d::getMomentumX()
      • setups::GeneralDiscontinuity1d::getMomentumY()
      • setups::GeneralDiscontinuity1d::getBathymetry()
      • setups::GeneralDiscontinuity1d::m_heightLeft
      • setups::GeneralDiscontinuity1d::m_heightRight
      • setups::GeneralDiscontinuity1d::m_momentumLeft
      • setups::GeneralDiscontinuity1d::m_momentumRight
      • setups::GeneralDiscontinuity1d::m_xdis
    • setups::RareRare1d
      • setups::RareRare1d::RareRare1d()
      • setups::RareRare1d::getHeight()
      • setups::RareRare1d::getMomentumX()
      • setups::RareRare1d::getMomentumY()
      • setups::RareRare1d::getBathymetry()
      • setups::RareRare1d::m_height
      • setups::RareRare1d::m_momentumLeft
      • setups::RareRare1d::m_xdis
    • setups::Setup
      • setups::Setup::~Setup()
      • setups::Setup::getHeight()
      • setups::Setup::getMomentumX()
      • setups::Setup::getMomentumY()
      • setups::Setup::getBathymetry()
    • setups::ShockShock1d
      • setups::ShockShock1d::ShockShock1d()
      • setups::ShockShock1d::getHeight()
      • setups::ShockShock1d::getMomentumX()
      • setups::ShockShock1d::getMomentumY()
      • setups::ShockShock1d::getBathymetry()
      • setups::ShockShock1d::m_height
      • setups::ShockShock1d::m_momentumLeft
      • setups::ShockShock1d::m_xdis
    • setups::Subcritical1d
      • setups::Subcritical1d::Subcritical1d()
      • setups::Subcritical1d::getHeight()
      • setups::Subcritical1d::getMomentumX()
      • setups::Subcritical1d::getMomentumY()
      • setups::Subcritical1d::getBathymetry()
      • setups::Subcritical1d::m_height
      • setups::Subcritical1d::m_momentum
    • setups::Supercritical1d
      • setups::Supercritical1d::Supercritical1d()
      • setups::Supercritical1d::getHeight()
      • setups::Supercritical1d::getMomentumX()
      • setups::Supercritical1d::getMomentumY()
      • setups::Supercritical1d::getBathymetry()
      • setups::Supercritical1d::m_height
      • setups::Supercritical1d::m_momentum
    • setups::TsunamiEvent1d
      • setups::TsunamiEvent1d::TsunamiEvent1d()
      • setups::TsunamiEvent1d::~TsunamiEvent1d()
      • setups::TsunamiEvent1d::getHeight()
      • setups::TsunamiEvent1d::getMomentumX()
      • setups::TsunamiEvent1d::getMomentumY()
      • setups::TsunamiEvent1d::getBathymetry()
      • setups::TsunamiEvent1d::computeD()
      • setups::TsunamiEvent1d::m_bathymetry
      • setups::TsunamiEvent1d::m_bathymetryDataSize
      • setups::TsunamiEvent1d::m_fileExists
      • setups::TsunamiEvent1d::m_pi
      • setups::TsunamiEvent1d::m_delta
    • setups::TsunamiEvent2d
      • setups::TsunamiEvent2d::TsunamiEvent2d()
      • setups::TsunamiEvent2d::~TsunamiEvent2d()
      • setups::TsunamiEvent2d::getHeight()
      • setups::TsunamiEvent2d::getMomentumX()
      • setups::TsunamiEvent2d::getMomentumY()
      • setups::TsunamiEvent2d::getBathymetry()
      • setups::TsunamiEvent2d::getBathymetryFromArray()
      • setups::TsunamiEvent2d::getDisplacementFromArray()
      • setups::TsunamiEvent2d::m_delta
      • setups::TsunamiEvent2d::m_bathymetryPath
      • setups::TsunamiEvent2d::m_displacementPath
      • setups::TsunamiEvent2d::m_bathymetryOffsetX
      • setups::TsunamiEvent2d::m_bathymetryOffsetY
      • setups::TsunamiEvent2d::m_displacementOffsetX
      • setups::TsunamiEvent2d::m_displacementOffsetY
      • setups::TsunamiEvent2d::m_bathymetrySampleDistanceX
      • setups::TsunamiEvent2d::m_bathymetrySampleDistanceXInverse
      • setups::TsunamiEvent2d::m_bathymetrySampleDistanceY
      • setups::TsunamiEvent2d::m_bathymetrySampleDistanceYInverse
      • setups::TsunamiEvent2d::m_displacementSampleDistanceX
      • setups::TsunamiEvent2d::m_displacementSampleDistanceXInverse
      • setups::TsunamiEvent2d::m_displacementSampleDistanceY
      • setups::TsunamiEvent2d::m_displacementSampleDistanceYInverse
      • setups::TsunamiEvent2d::m_nxB
      • setups::TsunamiEvent2d::m_nyB
      • setups::TsunamiEvent2d::m_xDataB
      • setups::TsunamiEvent2d::m_yDataB
      • setups::TsunamiEvent2d::m_b
      • setups::TsunamiEvent2d::m_nxD
      • setups::TsunamiEvent2d::m_nyD
      • setups::TsunamiEvent2d::m_xDataD
      • setups::TsunamiEvent2d::m_yDataD
      • setups::TsunamiEvent2d::m_d
• Solvers
  • solvers
    • solvers::Fwave
      • solvers::Fwave::netUpdates()
      • solvers::Fwave::computeEigenvalues()
      • solvers::Fwave::computeEigencoefficients()
      • solvers::Fwave::m_g
      • solvers::Fwave::l_gHalf
      • solvers::Fwave::m_gSqrt
    • solvers::Roe
      • solvers::Roe::netUpdates()
      • solvers::Roe::waveSpeeds()
      • solvers::Roe::waveStrengths()
      • solvers::Roe::m_gSqrt
• UI
  • ui
    • ui::GUI
      • ui::GUI::launch()
      • ui::GUI::exec()
      • ui::GUI::createConfigJson()
      • ui::GUI::updateSystemInfo()
      • ui::GUI::updateTimeValues()
      • ui::GUI::VERSION
      • ui::GUI::WINDOW_WIDTH
      • ui::GUI::WINDOW_HEIGHT
      • ui::GUI::m_communicator
      • ui::GUI::m_clientLog
      • ui::GUI::m_clientLogAutoScroll
      • ui::GUI::PORT
      • ui::GUI::IPADDRESS
      • ui::GUI::m_connected
      • ui::GUI::m_lastSystemInfoUpdate
      • ui::GUI::m_systemInfoUpdateFrequency
      • ui::GUI::m_logSystemInfoDataTransmission
      • ui::GUI::m_lastTimeValuesUpdate
      • ui::GUI::m_timeValuesUpdateFrequency
      • ui::GUI::m_logTimeValuesDataTransmission
      • ui::GUI::m_clientReadBufferSize
      • ui::GUI::m_clientSendBufferSize
      • ui::GUI::m_serverReadBufferSize
      • ui::GUI::m_serverSendBufferSize
      • ui::GUI::m_serverRestartPort
      • ui::GUI::m_compileModes
      • ui::GUI::m_compileMode
      • ui::GUI::m_compilerChoice
      • ui::GUI::m_optFlags
      • ui::GUI::m_optFlag
      • ui::GUI::m_ompFlags
      • ui::GUI::m_ompFlag
      • ui::GUI::m_ompNumThreads
      • ui::GUI::m_reportFlags
      • ui::GUI::m_reportFlag
      • ui::GUI::m_useFilesystem
      • ui::GUI::m_customEnv
      • ui::GUI::m_useGui
      • ui::GUI::m_runnerOptions
      • ui::GUI::m_runner
      • ui::GUI::m_checkpointBeforeRecomp
      • ui::GUI::m_sbJob
      • ui::GUI::m_sbOut
      • ui::GUI::m_sbErr
      • ui::GUI::m_sbTim
      • ui::GUI::m_configFilePath
      • ui::GUI::m_tsunamiEvents
      • ui::GUI::m_tsunamiEvent
      • ui::GUI::m_nx
      • ui::GUI::m_ny
      • ui::GUI::m_nk
      • ui::GUI::m_simulationSizeX
      • ui::GUI::m_simulationSizeY
      • ui::GUI::m_offsetX
      • ui::GUI::m_offsetY
      • ui::GUI::m_endTime
      • ui::GUI::m_useFileIO
      • ui::GUI::m_outputMethods
      • ui::GUI::m_outputMethod
      • ui::GUI::m_writingFrequency
      • ui::GUI::m_outputFileName
      • ui::GUI::m_stationFrequency
      • ui::GUI::m_checkpointFrequency
      • ui::GUI::m_height
      • ui::GUI::m_baseHeight
      • ui::GUI::m_diameter
      • ui::GUI::m_timeStepScaling
      • ui::GUI::m_transferLocalFilePath
      • ui::GUI::m_transferRemoteFilePath
      • ui::GUI::m_bathymetryFilePath
      • ui::GUI::m_displacementFilePath
      • ui::GUI::m_boundaryL
      • ui::GUI::m_boundaryR
      • ui::GUI::m_boundaryT
      • ui::GUI::m_boundaryB
      • ui::GUI::m_stations
      • ui::GUI::m_currStationX
      • ui::GUI::m_currStationY
      • ui::GUI::m_currStationName
      • ui::GUI::m_simulationStatus
      • ui::GUI::m_isPausing
      • ui::GUI::m_currentTimeStep
      • ui::GUI::m_maxTimeSteps
      • ui::GUI::m_timePerTimeStep
      • ui::GUI::m_estimatedTimeLeft
      • ui::GUI::m_cpuData
      • ui::GUI::m_totalRAM
      • ui::GUI::m_usedRAM
      • ui::GUI::m_stationTime
      • ui::GUI::m_stationBathymetry
      • ui::GUI::m_stationMomentumX
      • ui::GUI::m_stationMomentumY
      • ui::GUI::m_stationTotalHeight
      • ui::GUI::m_stationFilePath
      • ui::GUI::m_heightData
      • ui::GUI::m_bathymetryData
      • ui::GUI::m_scaleMin
      • ui::GUI::m_scaleMax
      • ui::GUI::m_currCellsX
      • ui::GUI::m_currCellsY
      • ui::GUI::m_currOffsetY
      • ui::GUI::m_currOffsetX
      • ui::GUI::m_currSimSizeX
      • ui::GUI::m_currSimSizeY
      • ui::GUI::Station
        • ui::GUI::Station::name
        • ui::GUI::Station::positionX
        • ui::GUI::Station::positionY
        • ui::GUI::Station::isSelected