NeurApp 1.1
NeurApp - software for exploring approximation by artificial neural networks on functions of one or two variables.

IG::Num::ConvectionRobertFileManager Class Reference

File manager for interfacing simulation casting simulator of Robert Vertnik. More...

Inheritance diagram for IG::Num::ConvectionRobertFileManager:
Collaboration diagram for IG::Num::ConvectionRobertFileManager:

List of all members.

Public Member Functions

 ConvectionRobertFileManager (string rootDirectory)
 Constructs a file manager for interfacing simulation casting simulator of Robert Vertnik.
override void WriteInputParameters (IVector inputParameters)
 Writes optimization input parameters to the standard location.
override void ReadOutputValues (ref IVector outputValues)
 Reads optimization output values form the file at a standard location. If for some reason the file does not exist or it is corrupted, the vector of output values is set to null.
override void ReadInputParameters (ref IVector inputParameters)
 Reads optimization input parameters form the file at a standard location.
virtual void WriteInputParameters (IVector inputParameters, string inputPath)
 Writes optimization input parameters to the standard location.
virtual void DeleteOutputFiles ()
 Deletes the output files. It is recommendable to delete simulation output before running simulation. In this way, one would know if the simulation program has been broken because the output file would not exist or would be corrupted (otherwise, one could simply read the output file genenerated in some previout run, without noticing that something is wrong).
virtual void ReadOutputValues (ref IVector outputValues, string outputPath)
 Reads optimization output values form the file at a standard location. If for some reason the file does not exist or it is corrupted, the vector of output values is set to null.
override void WriteOutputValues (IVector outputValues)
 Writes optimization ouptut values to the standard location.

Public Attributes

new string _executableFilename = "2DNatConvCavity.exe"
string OptInputJsonFilename = "input.txt"
string OptOutputJsonFilename = "output.txt"

Protected Attributes

new int _numInputParameters = 2
new int _numOutputValues = 3
int _numProcessors = 1

Properties

virtual string ExecutableFilename [get, set]
override string ExecutablePath [get, set]
 File path of simulator's executable. Only pure file name can be provided (if the full path is provided then only the file name is extracted, and the related path is calculated when firs needed). If set to null then file path is set to null and will be recalculated when getter is called.
override string ExecutableDirpath [get, set]
 Path of the directory where executable is located. Setter takes only pure directory name, without path information. If set to null then directory path is set to null and will be recalculated when getter is called.
string InputPath [get, set]
string OutputPath [get, set]
override string OptInputJsonPath [get, set]
 Path to the file that contains optimization input (usually stored by the caller of simulator). Only pure file name can be provided (if the full path is provided then only the file name is extracted, and the related path is calculated when firs needed). If set to null then file path is set to null and will be recalculated when getter is called.
override string OptOutputJsonPath [get, set]
 Path to the file where optimization output values are stored by simulator. Only pure file name can be provided (if the full path is provided then only the file name is extracted, and the related path is calculated when firs needed). If set to null then file path is set to null and will be recalculated when getter is called.
override int NumInputParameters [get, set]
 Number of input optimization parameters for the simulator.
override int NumOutputValues [get, set]
 Number of optimization output values produced by the simulator.
virtual int NumProcessors [get, set]
 Number of processors that the program allocates for computing.

Detailed Description

File manager for interfacing simulation casting simulator of Robert Vertnik.

$A Igor May13;


Constructor & Destructor Documentation

IG::Num::ConvectionRobertFileManager::ConvectionRobertFileManager ( string  rootDirectory) [inline]

Constructs a file manager for interfacing simulation casting simulator of Robert Vertnik.

Parameters:
rootDirectoryRoot directory containing all base directories for simulator data.
projectNameName of the project, which determines nmes of subdirectories of base directories that contain data for the current project.
simulationNameSimulation name, which determines e.g. names of optimization input and output files used for data exchange between optimization and simulation.

Member Function Documentation

override void IG::Num::ConvectionRobertFileManager::WriteInputParameters ( IVector  inputParameters) [inline, virtual]

Writes optimization input parameters to the standard location.

Parameters:
outputValuesParameters to be written.

Reimplemented from IG::Num::SimCastingRobertFileManager.

Reimplemented in IG::Num::ConvectionRev1RobertFileManager.

override void IG::Num::ConvectionRobertFileManager::ReadOutputValues ( ref IVector  outputValues) [inline, virtual]

Reads optimization output values form the file at a standard location. If for some reason the file does not exist or it is corrupted, the vector of output values is set to null.

Parameters:
outputValuesReference to an object where output parameters will be stored.

Reimplemented from IG::Num::SimCastingRobertFileManager.

override void IG::Num::ConvectionRobertFileManager::ReadInputParameters ( ref IVector  inputParameters) [inline, virtual]

Reads optimization input parameters form the file at a standard location.

Parameters:
inputParametersReference to an object where input parameters are stored.

Reimplemented from IG::Num::SimCastingRobertFileManager.

virtual void IG::Num::ConvectionRobertFileManager::WriteInputParameters ( IVector  inputParameters,
string  inputPath 
) [inline, virtual]

Writes optimization input parameters to the standard location.

Parameters:
outputValuesParameters to be written.
outputValuesPath to the input file.

Reimplemented in IG::Num::ConvectionRev1RobertFileManager.

virtual void IG::Num::ConvectionRobertFileManager::DeleteOutputFiles ( ) [inline, virtual]

Deletes the output files. It is recommendable to delete simulation output before running simulation. In this way, one would know if the simulation program has been broken because the output file would not exist or would be corrupted (otherwise, one could simply read the output file genenerated in some previout run, without noticing that something is wrong).

Reimplemented from IG::Num::SimCastingRobertFileManager.

virtual void IG::Num::ConvectionRobertFileManager::ReadOutputValues ( ref IVector  outputValues,
string  outputPath 
) [inline, virtual]

Reads optimization output values form the file at a standard location. If for some reason the file does not exist or it is corrupted, the vector of output values is set to null.

Parameters:
outputValuesReference to an object where output parameters will be stored.
override void IG::Num::ConvectionRobertFileManager::WriteOutputValues ( IVector  outputValues) [inline, virtual]

Writes optimization ouptut values to the standard location.

Parameters:
outputValuesValues to be written.

Reimplemented from IG::Num::SimCastingRobertFileManager.


Member Data Documentation


Property Documentation

virtual string IG::Num::ConvectionRobertFileManager::ExecutableFilename [get, set]
override string IG::Num::ConvectionRobertFileManager::ExecutablePath [get, set]

File path of simulator's executable. Only pure file name can be provided (if the full path is provided then only the file name is extracted, and the related path is calculated when firs needed). If set to null then file path is set to null and will be recalculated when getter is called.

Reimplemented from IG::Num::SimCastingRobertFileManager.

override string IG::Num::ConvectionRobertFileManager::ExecutableDirpath [get, set]

Path of the directory where executable is located. Setter takes only pure directory name, without path information. If set to null then directory path is set to null and will be recalculated when getter is called.

Reimplemented from IG::Num::SimCastingRobertFileManager.

string IG::Num::ConvectionRobertFileManager::InputPath [get, set]
string IG::Num::ConvectionRobertFileManager::OutputPath [get, set]
override string IG::Num::ConvectionRobertFileManager::OptInputJsonPath [get, set]

Path to the file that contains optimization input (usually stored by the caller of simulator). Only pure file name can be provided (if the full path is provided then only the file name is extracted, and the related path is calculated when firs needed). If set to null then file path is set to null and will be recalculated when getter is called.

Reimplemented from IG::Num::SimCastingRobertFileManager.

override string IG::Num::ConvectionRobertFileManager::OptOutputJsonPath [get, set]

Path to the file where optimization output values are stored by simulator. Only pure file name can be provided (if the full path is provided then only the file name is extracted, and the related path is calculated when firs needed). If set to null then file path is set to null and will be recalculated when getter is called.

Reimplemented from IG::Num::SimCastingRobertFileManager.

override int IG::Num::ConvectionRobertFileManager::NumInputParameters [get, set]

Number of input optimization parameters for the simulator.

Reimplemented from IG::Num::SimCastingRobertFileManager.

Reimplemented in IG::Num::ConvectionRev1RobertFileManager.

override int IG::Num::ConvectionRobertFileManager::NumOutputValues [get, set]

Number of optimization output values produced by the simulator.

Reimplemented from IG::Num::SimCastingRobertFileManager.

virtual int IG::Num::ConvectionRobertFileManager::NumProcessors [get, set]

Number of processors that the program allocates for computing.


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Enumerations Properties