Package for using OpenFLUID within the GNU R environment

Documentation for package ‘ROpenFLUID’ version 1.7.2

Help Pages

OpenFLUID.addExtraFunctionsPaths Adds paths to search for simulation functions
OpenFLUID.createInputData Creates an inputdata for alla spatial units of a class, initialized with a default value
OpenFLUID.getDeltaT Returns the simulation time step
OpenFLUID.getExtraFunctionsPaths Returns the added paths to search for simulation functions
OpenFLUID.getFunctionParam Returns a function parameter value
OpenFLUID.getGeneratorParam Returns a generator parameter value
OpenFLUID.getInputData Returns an inputdata value for a given spatial unit
OpenFLUID.getModelGlobalParam Returns a model global parameter value
OpenFLUID.getPeriodBeginDate Returns the simulation period begin date
OpenFLUID.getPeriodEndDate Returns the simulation period end date
OpenFLUID.getUnitsClasses Returns the existing units classes
OpenFLUID.getUnitsIDs Returns the existing units IDs for a given units class
OpenFLUID.getVersion Returns the OpenFLUID version
OpenFLUID.loadResult Loads results as a dataframe, giving output dataset informations
OpenFLUID.loadResultFile Loads results as a dataframe, giving output file name
OpenFLUID.openDataset Opens a dataset and returns a simulation definition blob
OpenFLUID.openProject Opens a project and returns a simulation definition blob
OpenFLUID.printSimulationInfo Prints informations to screen about simulation definition blob
OpenFLUID.runProject Runs a project and returns a simulation definition blob
OpenFLUID.runSimulation Runs a simulation from a simulation definition blob
OpenFLUID.setCurrentOutputDir Sets the current output directory for simulations
OpenFLUID.setDeltaT Sets the simulation time step
OpenFLUID.setFunctionParam Sets a function parameter value
OpenFLUID.setGeneratorParam Sets a generator parameter value
OpenFLUID.setInputData Sets an inputdata value for a given spatial unit
OpenFLUID.setModelGlobalParam Sets a model global parameter value
OpenFLUID.setPeriodBeginDate Sets the simulation period begin date
OpenFLUID.setPeriodEndDate Sets the simulation period end date
ROpenFLUID Package for using OpenFLUID within the GNU R environment