IGLib  1.7.2
The IGLib base library EXTENDED - with other lilbraries and applications.
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events Macros
IG.Script.S_12_09_jmatpro Class Reference

Script class for running JMatPro calculations and manipulating results. More...

+ Inheritance diagram for IG.Script.S_12_09_jmatpro:
+ Collaboration diagram for IG.Script.S_12_09_jmatpro:

Classes

class  StoredScriptSettings
 In methods of this class you will find all the settings that apply to this script. More...
 

Public Member Functions

 S_12_09_jmatpro ()
 
override void Script_AddCommands (ICommandLineApplicationInterpreter interpreter, SortedList< string, string > helpStrings)
 Adds commands to the internal interpreter. More...
 
string CommandCustom (string[] args)
 Custom JMatPro operations (for development tasks and quick auxiliary tasks). More...
 
string CommandPrepareData (string[] args)
 Prepares definition data for running the JMatPro material calculations and subsequent numerical simulations based on these results. Also prepares a template settings file and a file with input parameters (in two forms, as vector and as default values in definition data) that can be used as default material parameters. More...
 
string CommandKillJmat (string[] args)
 Kills eventually running JMatPro process(es). More...
 
string CommandIsJmatRunning (string[] args)
 Tells whether JMatPro is currently running. More...
 
string CommandCalculateMaterial (string[] args)
 Calculates material properties at specific parameters that are read from a json file as vector object. More...
 
string CommandCalculateMaterialDef (string[] args)
 Calculates material properties at specific parameters that are read from a json file as data definition object where default input values are taken as parameters. More...
 
string CommandCalculateMaterialsRandom (string[] args)
 Calculates material properties at a parameter sets that are chosen uniformly randomly within material parameter bounds. Second argument can specify the number of calculations, if not specified then default number is taken. More...
 
string CommandWriteMaterialStatistics (string[] args)
 Writes statistics about material properties calculation to the console and to the log file. More...
 
string CommandWriteMaterialsCalculated (string[] args)
 Prints (to console and log file) information about material directories where material properties were successfully calculated. More...
 
string CommandReleaseAbandonedMutex (string[] args)
 Releases the file access locking mutex used by the JMatPro interface' file manager. Returns true if the mutex ha been abandoned and has thus actually been released. First argument is the path to the settings file used. More...
 
string CommandClearBusyFlags (string[] args)
 Clears the busy flags from all or from specified material calculation directories. More...
 
string CommandRetryCalculateMaterialProperties (string[] args)
 Retries calculation of material properties in all material calculation directories where calculation has not completed successfully, or from the specified material calculation directories. More...
 
string CommandMoveMaterialDirectoriesMaterialCalculated (string[] args)
 Moves to the appropriate storage directory those material directories where material properties were successfully calculated. More...
 
string CommandMoveMaterialDirectoriesBusyFlagSet (string[] args)
 Moves to the appropriate storage directory those material directories where busy flag remained set. More...
 
string CommandMoveMaterialDirectoriesTimedout (string[] args)
 Moves to the appropriate storage directory those material directories where material properties calculation has timed out. More...
 
string CommandMoveMaterialDirectoriesCalculationFailed (string[] args)
 Moves to the appropriate storage directory those material directories where calculation of material properties failed. More...
 
string CommandMoveMaterialDirectoriesDataCorrupted (string[] args)
 Moves to the appropriate storage directory those material directories where material data is corrupted (e.g. material parameters are not properly written). More...
 
string CommandMoveMaterialDirectoriesAll (string[] args)
 Moves all material directories to the appropriate storage directories. More...
 
string CommandSaveSettings (string[] args)
 Saves the settings that are read from the specified settings file. Purpose of this is to verify that all settings have been read correctly and as expected and are restored correctly when saving. For example, correct function of the include property in settings file can be verified by this. More...
 
string CommandTestRestart (string[] args)
 Tests functions related to restart procedures, including the mapping from material parameters to material directory name. More...
 
string CommandTestMaterialResults (string[] args)
 Checks material result file from the specified material directory (or from all successful & failed directories, if material directories are not specified) and writes basic information about the results, including whether results are uncorrupted. More...
 
- Public Member Functions inherited from IG.Script.LoadableScriptShellNeuralIT
 LoadableScriptShellNeuralIT ()
 
override void Script_AddCommands (ICommandLineApplicationInterpreter interpreter, SortedList< string, string > helpStrings)
 Adds commands to the internal interpreter. More...
 
void TrainANN ()
 Train the artificial neural network. More...
 
void PlotTrainingRmsError (List< NeuralTrainingParameters > trainParameters, bool showMinAndMaxError, bool showMinToMaxError, bool showBestNErrors, int numErrorsShow, int numBoundles)
 Plots graph for training Rms errors. More...
 
void PlotTrainingMaxError (List< NeuralTrainingParameters > trainParameters, bool showMinAndMaxError, bool showMinToMaxError, bool showBestNErrors, int numErrorsShow, int numBoundles)
 Plots graph for training Max errors. More...
 
void PlotVerificationRmsError (List< NeuralTrainingParameters > trainParameters, bool showMinAndMaxError, bool showMinToMaxError, bool showBestNErrors, int numErrorsShow, int numBoundles)
 Plots graph for verification Rms errors. More...
 
void PlotVerificationMaxError (List< NeuralTrainingParameters > trainParameters, bool showMinAndMaxError, bool showMinToMaxError, bool showBestNErrors, int numErrorsShow, int numBoundles)
 Plots graph for verification Max errors. More...
 
virtual void ApplyPlotSettings (PlotterZedGraph plotter, PlotZedGraphBase plot)
 Applies basic plot settings for various kinds of plots. More...
 
virtual void ApplyPlotSettingsCurveRGB (PlotterZedGraph plotter, PlotZedgraphCurve plot, double r, double g, double b)
 
virtual void ApplyPlotSettingsCurve (PlotterZedGraph plotter, PlotZedgraphCurve plot)
 Applies basic plot settings for basic kinds of curve plots. More...
 
virtual void ApplyPlotSettingsCurve (PlotterZedGraph plotter, PlotZedgraphCurve plot, int i, int max)
 Applies basic plot settings for basic kinds of curve plots where groups of curves are plotted. More...
 
virtual void ApplyPlotSettingsCurveBlueRed (PlotterZedGraph plotter, PlotZedgraphCurve plot, int i, int max)
 Applies basic plot settings for basic kinds of curve plots where groups of curves are plotted. More...
 
virtual void ApplyPlotSettingsCurveMonotoneBlue (PlotterZedGraph plotter, PlotZedgraphCurve plot, int i, int max)
 
virtual void ApplyPlotSettingsCurveMonotoneRed (PlotterZedGraph plotter, PlotZedgraphCurve plot, int i, int max)
 
virtual void PlotNeuralResponse (IVector parameters, int whichOut, int whichParam, double minParam, double maxParam, int numPoints)
 Plots a parametrix stydy of neural network approximated response by plotting dependency of the specified output on the specified parameter. More...
 
virtual void PlotNetworkResponse (int numPoints)
 Plots some parametric studies of responses generated by the trained network. More...
 
virtual void PlotNetworkResponseGrouped (IVector parameters, int whichOut, IBoundingBox parameterBounds, int numPoints)
 Plots a parametrix stydy of neural network approximated response by plotting dependency of the specified output on the specified parameter. More...
 
virtual void PlotNetworkResponseGrouped (int numPoints)
 Plots some parametric studies of responses generated by the trained network. More...
 
virtual void PlotAnalysisTable (AnalysisResults[] tabres)
 Plots the specified table of analysis results. More...
 
virtual void PlotApproximationTable (IVector[][] tabApproximationResults)
 Plots the specified table of calculated approximation results. More...
 
void PlotVerificationError (bool showErrorInPercentage, bool verificationPoFromFile)
 Plots the ANN approximation on verification points and real points. More...
 
void PlotVerificationError (bool verificationFromFile, int whichOutput)
 Plots the ANN approximation on verification points and real points. More...
 
void PlotVerificationError (bool showErrorInPercentage, bool verificationFromFile, int whichOutput)
 Plots the ANN approximation on verification points and real points. More...
 
void CalculateVerificationError (int whichOut, ref List< IVector > verificationPointsResponse)
 Calculates response on verification points. More...
 
void CalculateVerificationError (bool verificationFromFile, int whichOut, ref List< IVector > verificationPointsResponse)
 Calculates response on verification points. More...
 
void PlotTrainingError ()
 Plots the ANN approximation on training points and real points. More...
 
void PlotTrainingError (int whichOutput)
 Plots the ANN approximation on training points and real points. More...
 
void PlotTrainingError (bool showErrorInPercentage, int whichOutput)
 Plots the ANN approximation on training points and real points. More...
 
void CalculateTrainingError (int whichOut, ref List< IVector > trainingPointsResponse)
 Calculates response on training points. More...
 
void PointsOnLine ()
 Network response on the points calculated between two selected points. More...
 
void PlotResponseOnLine (IVector p1Training, IVector p2Training, IVector p1Verification, IVector p2Verification, int numPoints)
 Network response on the points calculated between two selected points. More...
 
void PlotTrainingAndVerificationPointsResponse (List< IVector > selectedTrainingPoints, List< IVector > selectedVerificationPoints, int whichOutput, int whichParameter, double min, double max)
 Plots the ANN approcimation on the verification points and/or real points. More...
 
SampledDataSet GetVerificationFromApproximator ()
 Returns verification points from complete training data set in approximator. More...
 
SampledDataSet GetTrainingFromApproximator ()
 Returns training points from complete training data set in approximator. More...
 
void SensitivityStart ()
 Perform sensitiviy test from training and verification data. More...
 
void SensitivityPerform (IVector trainingCenterPoint, IVector verificationCenterPoint)
 
void CenterPointResponse ()
 Plots the ANN approcimation on the center point from verification point and/or real point. More...
 
void PlotNetworkCenteredPointResponse (IVector trainingCenterPoint, IVector verificationCenterPoint)
 Plots the ANN approcimation on the center point from verification point and/or real point. More...
 
void CalculateSensitivity (IVector selectedTrainingPoint, IVector selectedVerificationPoint, int whichParameter, double min, double max)
 
void PlotTrainingAndVerificationPointResponse (IVector selectedTrainingPoint, IVector selectedVerificationPoint, int whichOutput, int whichParameter, double min, double max)
 Plots the ANN approcimation on the verification point and real point. More...
 
void CenterPoint (INeuralApproximator Approximator, ref IVector inputCenterParameters, bool centerOnTrainingPoint)
 Calculate the average center point for each parameter from complete data set. More...
 
void CenterPoint (SampledDataSet DataSet, ref IVector inputCenterParameters)
 Calculate the average center point for each parameter from complete data set. More...
 
virtual string TrainNetwork (string[] arguments)
 
virtual string TrainParallelExample (string[] arguments)
 Performs parallel training of neural networks with different parameters and default data. More...
 
virtual string PlotConvergence (string[] arguments)
 Plot different convergences from traininglimits file More...
 
virtual string PlotTrainingTime (string[] arguments)
 Plot graph sorted on training time. More...
 
virtual string PlotVerificationResponse (string[] arguments)
 Plot the approximated response of the neural network in the verification points. More...
 
virtual string PlotTrainingResponse (string[] arguments)
 Plot the approximated response of the neural network in the training points. More...
 
virtual string PlotNetworkResponseOnLineAll (string[] arguments)
 Plot the approximated responses of the neural network on two selected points and on the points between them. More...
 
string PlotNetworkCenteredPoint (string[] arguments)
 Pots parametric study on center point from training and/or verification sets. More...
 
string Sensitivity (string[] arguments)
 Execute sensitivity test and saves to CSV file. More...
 
- Public Member Functions inherited from IG.Script.LoadableScriptShellNeuralITOriginalBase
 LoadableScriptShellNeuralITOriginalBase ()
 
override void Analyse (Num.IAnalysisResults anRes)
 Dummy analysis, jsut throws the exception. More...
 
virtual string Test (string[] arguments)
 Runs a custom basic test. More...
 
virtual string Custom (string[] arguments)
 Runs a custom test. More...
 
virtual string RunParallelSimulations (string[] arguments)
 Runs multiple simulations in parallel threads and saves results in each parallel thread. More...
 
virtual string CollectParallelSimulationResults (string[] arguments)
 Collects results of simulations run in parallel threads, joins them into a single object and saves them. More...
 
override void Script_AddCommands (ICommandLineApplicationInterpreter interpreter, SortedList< string, string > helpStrings)
 Adds commands to the internal interpreter. More...
 
virtual IVector TestApproximation (IVector parameters)
 Performs a test approximation at the specified vector of parameters and outputs and returns results. More...
 
virtual IVector[][] TestApproximationTable (int numPoints)
 Calculates a table of specified number of approximations, with parameters running between two points that are chosen by the algorithm. More...
 
virtual IVector[][] TestApproximationTable (IVector param1, IVector param2, int numPoints)
 Performs a table of approximatinos between two specified vectors of approximation input parameters, and outputs results. It also returns the table of results (approximated output values in form of vectors). More...
 
virtual AnalysisResults TestAnalysis (IVector parameters)
 Performs test analysis at the specified optimization parameters and outputs results. More...
 
virtual AnalysisResults[] TestAnalysisTable (int numPoints)
 Calculates a table of specified number of analyses, with parameters running between two points that are chosen by the algorithm. More...
 
virtual AnalysisResults[] TestAnalysisTable (IVector param1, IVector param2, int numPoints)
 Performs a table of direct analyses between two specified vectors of optimization parameters, and outputs results. It also returns the table of analysis results. More...
 
virtual void OptimizeSimplex ()
 
virtual void TransfNeuralToOptimizationParameters (IVector neuralParameters, ref IVector optimizationParameters)
 Maps input parameters for neural network to optimization input parameters. More...
 
virtual void TransfOptimizationToNeuralParameters (IVector optimizationParameters, ref IVector neuralParameters)
 Maps optimization input parameters to neural network input parameters. More...
 
delegate string ParallelRunDelegate (int threadIndex)
 
virtual void ParSimBegin (int numThreads)
 Launches parallel jobs. More...
 
virtual void GatherParallelResults (int numThreads)
 Reads results form all parallel threads, gathers them in a single training set, and saves them in the template optimiation directory. More...
 
virtual string ParSimGetOptimizationDirectoryPath (int threadIndex)
 Returns path to the directory containing optimization data for the specified parallel thread. More...
 
virtual string ParSimGetMutexName (int threadIndex)
 Returns name of the mutex for locking data on disk that is used by the specified parallel thread. More...
 
virtual string ParSimGetParallelResultsFilePath (int threadIndex)
 Returns path of the file where resuls of calculation in the specified parallel thread are stored. More...
 
virtual string GetParallelResultFilePath ()
 Returns path of the file where resuls of calculation in the specified parallel thread are stored. More...
 
virtual void ParSimPreparelDirectory (int threadIndex)
 Prepares data for running calculations in the parallel thread with the specified index. More...
 
void ParSimAddResults (int threadIndex, SampledDataSet results)
 Reads results of the specified thread and adds them to the existing training set. More...
 
string ParSimRunJob (int threadIndex)
 Runs the job in the specified parallel thread. More...
 
virtual void ParSimGetNextInput (ref IVector simInput)
 Generates the next vector of simulation input parameters that will be used for calculation of a new parallel simulation. More...
 
virtual void ParSimGetNextNeuralInput (ref IVector simInput)
 Generates the next vector of neural input parameters that will be used for calculation of a new training element. More...
 
virtual string ParSimGetSimulationDirectoryPath (int threadIndex)
 Returns the simulation directory for the specified parallel calculation thread. More...
 
virtual
IResponseEvaluatorVectorSimple 
ParSimGetSimulator (int threadIndex)
 Creates simulator file manager for the simulator that will the specified parallel task. More...
 
override void TransfSimulationToNeuralInput (IVector original, ref IVector result)
 Transforms the specified vector of simulation input parameters to the vector of neural input parameters and stores the vector to the specified variable. More...
 
override void TransfNeuralToSimulationInput (IVector original, ref IVector result)
 Transforms the specified vector of neural input parameters to the vector of simulation input parameters and stores the vector to the specified variable. More...
 
override void TransfSimulationToNeuralOutput (IVector original, ref IVector result)
 Transforms the specified vector of simulation output values (results) to the vector of neural output values and stores the vector to the specified variable. More...
 
virtual void TransfNeuralToSimulationOutput (IVector original, ref IVector result)
 Transforms the specified vector of neural output values to the vector of simulation output values (results) and stores the vector to the specified variable. More...
 
virtual SampledDataElement GetTrainingElement (int i)
 Gets the training element with the specified index (chosen out of al training points, including verificaion points). More...
 
virtual bool IsVerificationPoint (int trainingPointIndex)
 Whether the training point with the specified index is a verification points and has not been used in training. More...
 
List< SampledDataElementGetTrainingElements (bool includeVerificationPoints)
 Returns a list of all neural training elements. More...
 
List< SampledDataElementGetTrainingElements (bool includeVerificationPoints, bool includeNonVerificationPoints)
 Returns a list of all neural training elements. More...
 
virtual void GetNeuralInputPerturbance (double ratio, ref IVector perturbance)
 Returns a perturbance vector whose componenets represent magnitudes of perturbances of neural input parameters with the specified relative ratio with corresponding parameters' scaling lengths. More...
 
virtual void GetNeuralOutputPerturbance (double ratio, ref IVector perturbance)
 Returns a perturbance vector whose componenets represent magnitudes of perturbances of neural output values with the specified relative ratio with corresponding values' scaling lengths. More...
 
virtual void GetNeuralInputVector (double relativeComponents, ref IVector inputVector)
 Returns an input vector whose components are at specified relative distances (with respect to full range) from lower bounds on componens of input vectors. More...
 
virtual void GetNeuralOutputVector (double relativeComponents, ref IVector outputVector)
 Returns an output vector whose components are at specified relative distances (with respect to full range) from lower bounds on componens of input vectors. More...
 
virtual void GetNeuralInputVector (IVector relativeComponents, ref IVector inputVector)
 Returns an input vector whose components are at specified relative distances (with respect to full range) from lower bounds on componens of input vectors. More...
 
virtual void GetNeuralOutputVector (IVector relativeComponents, ref IVector outputVector)
 Returns an output vector whose components are at specified relative distances (with respect to full range) from lower bounds on componens of input vectors. More...
 
virtual void GetNeuralInputRelative (IVector inputVector, ref IVector relativeComponents)
 Calculates relative components (running from 0 to 1 within bounds for specified vector component) for the specified vector of neural input parameters. More...
 
virtual void GetNeuralOutputRelative (IVector outputVector, ref IVector relativeComponents)
 Calculates relative components (running from 0 to 1 within bounds for specified vector component) for the specified vector of neural output values. More...
 
virtual double InputDistance (IVector v1, IVector v2)
 Returns measure of distance between two vectors in the space of input parameters. Euclidean norm scaled accorging to individual parameter ranges is returned. More...
 
virtual double OutputDistance (IVector v1, IVector v2)
 Returns measure of distance between two vectors in the space of output parameters. Euclidean norm scaled accorging to individual parameter ranges is returned. More...
 
virtual double InputDistance (IVector v1, int trainingPointIndex)
 Returns measure of distance between the specified neural input vector and vector of input parameters of the training point with the specified index. More...
 
virtual double OutputDistance (IVector v1, int trainingPointIndex)
 Returns measure of distance between the specified neural output values vector and vector of output values of the training point with the specified index. More...
 
virtual int GetClosestInputIndex (IVector v1, bool includeVerificationPoints)
 Returns index of training element with the shortest distance of its input parameters to the specified vector. More...
 
virtual int GetClosestOutputIndex (IVector v1, bool includeVerificationPoints)
 Returns index of training element with the shortest distance of its output values to the specified vector of output values. More...
 
void TestClosestPoints (int numClosestPoints, bool includeVerificationPoints, bool printByComponents, params IVector[] points)
 For each point in the specified array, the training points are sorted according to the distance to this point, and data for the specified number of closest points are written. More...
 
void TestClosestPoints (int numClosestPoints, bool includeVerificationPoints, bool printByComponents, bool printIndividualPointsComp, params IVector[] points)
 For each point in the specified array, the training points are sorted according to the distance to this point, and data for the specified number of closest points are written. More...
 
void TestClosestPoints (int numClosestPoints, bool includeVerificationPoints, bool printByComponents, params SampledDataElement[] points)
 For each point (training element) in the specified array, the training points are sorted according to the distance to this point, and data for the specified number of closest points are written. More...
 
void TestClosestPoints (int numClosestPoints, bool includeVerificationPoints, bool printByComponents, bool printIndividualPointsComp, params SampledDataElement[] points)
 For each point (training element) in the specified array, the training points are sorted according to the distance to this point, and data for the specified number of closest points are written. More...
 
virtual void NeuralCalculate (params double[] inputParameters)
 Calculates approximation at specified input parameters. More...
 
virtual void NeuralCalculate (IVector inputParameters)
 Calculates approximation at specified input parameters. More...
 
virtual void NeuralCalculate (IVector inputParameters, ref IVector outputValues)
 Calculates approximation at specified input parameters. More...
 
virtual List< SampledDataElementGetRandomTrainingElements (int numElements, bool includeVerificationPoints)
 Creates and returns a list of training elements that are randomly chosen from the current training set. Trainingpoints that are not verification points are always included in the set of points for selection. More...
 
virtual List< SampledDataElementGetRandomTrainingElements (int numElements, bool includeVerificationPoints, bool includeNonVerificationPoints)
 Creates and returns a list of training elements that are randomly chosen from the current training set. More...
 
virtual List< SampledDataElementGetRandomTrainingElements (IRandomGenerator rand, int numElements, bool includeVerificationPoints)
 Creates and returns a list of training elements that are randomly chosen from the current training set. Trainingpoints that are not verification points are always included in the set of points for selection. More...
 
virtual List< SampledDataElementGetRandomTrainingElements (IRandomGenerator rand, int numElements, bool includeVerificationPoints, bool includeNonVerificationPoints)
 Creates and returns a list of training elements that are randomly chosen from the current training set. More...
 
virtual IVector GetRandomNeuralInput ()
 Creates and returns a random vector of neural input parameters whose elements (components) lie within the lower and upper bounds on parameters. More...
 
virtual void GetRandomNeuralInput (IRandomGenerator rand, ref IVector result)
 Generates a random vector of neural input parameters whose elements (components) lie within the lower and upper bounds on parameters, and stores it to the specified vector. More...
 
virtual IVector GetRandomNeuralInput (IRandomGenerator rand)
 Creates and returns a random vector of neural input parameters whose elements (components) lie within the lower and upper bounds on parameters. More...
 
virtual void GetRandomNeuralInput (ref IVector result)
 Generates a random vector of neural input parameters whose elements (components) lie within the lower and upper bounds on parameters. More...
 
virtual IVector GetRandomNeuralOutput ()
 Creates and returns a random vector of neural output values whose elements (components) lie within the lower and upper bounds on values. More...
 
virtual IVector GetRandomNeuralOutput (IRandomGenerator rand)
 Creates and returns a random vector of neural output values whose elements (components) lie within the lower and upper bounds on values. More...
 
virtual void GetRandomNeuralOutput (ref IVector result)
 Generates a random vector of neural output values whose elements (components) lie within the lower and upper bounds on values. More...
 
virtual void GetRandomNeuralOutput (IRandomGenerator rand, ref IVector result)
 Generates a random vector of neural output values whose elements (components) lie within the lower and upper bounds on neural output values, and stores it to the specified vector. More...
 
virtual void PrepareNeuronsTable (int minNeurons, int maxNeurons, int numNeurons, ref int[] neurpnsTable)
 Prepares table of neurons in geometric sequence. More...
 
void TrainANN (int annType, int NumNeurons, int MaxEpochs, int EpochsInBundle, double LearnignRate, double Momentum, double InputSafetyFactor, double OutputSafetyFactor, double PercentVerificationPoints)
 Train the artificial neural network. More...
 
virtual string CreateDistortedModelData (string[] arguments)
 Creates data for distorted model and stores the data in the specified directory. More...
 
virtual string StochasticCreateInput (string[] arguments)
 Creates a sample input file for analysis of influence of stochastic variables. More...
 
virtual string StochasticInfluence (string[] arguments)
 Analysis influence of stochastivc input parameters with specified means and standard deviations on the output values of the model. More...
 
virtual string CreateBinarySampledData (string[] arguments)
 Reads sampled data from the standard location and stores it in the same directory in binary form, in the file with extension .bin *_binaryTrainingDataExtension(. More...
 
virtual string RestoreBinarySampledData (string[] arguments)
 Reads sampled data in binary form from from the standard location and stores it in the same directory in JSON, in the file with extension .jsonrestored (_restoredTrainingDataExtension). More...
 
virtual void TestDistances (int referencePointIndex, int maxNumPoints)
 Test of distances of a specified number of training points with respect to the training point with specified index, in the input parameters space as well as in the output parameter space. More...
 
virtual void TestNeuralSpeed (int numEvaluations)
 Performs test of speed of calculation of neural network. More...
 
virtual void PrintNeuralData ()
 This example demonstrates how to extract data necessary for definition of optimization problems. More...
 
void SaveSensitivityCSV ()
 Saves sensitivity test in csv file. More...
 
- Public Member Functions inherited from IG.Script.ScriptShellNeuralWithSimulatorManagers
virtual void InitSimCastingRobert (string rootDirectory, string projectName, string simulationName)
 Initializes the data for casting simulation interface. More...
 
virtual void InitSimConvectionRobert (string rootDirectory, string projectName, string simulationName)
 Initializes the data for Convection simulation interface. More...
 
- Public Member Functions inherited from IG.Script.LoadableScriptShellNeural
 LoadableScriptShellNeural ()
 
override void Analyse (Num.IAnalysisResults anRes)
 Dummy analysis, jsut throws the exception. More...
 
- Public Member Functions inherited from IG.Script.LoadableScriptShellNeuralBase
 LoadableScriptShellNeuralBase ()
 
override void Analyse (Num.IAnalysisResults anRes)
 Dummy analysis, jsut throws the exception. More...
 
delegate string ParallelRunDelegate (int threadIndex)
 
void ParSimAddResults (int threadIndex, SampledDataSet results)
 Reads results of the specified thread and adds them to the existing training set. More...
 
string ParSimRunJob (int threadIndex)
 Runs the job in the specified parallel thread. More...
 
List< SampledDataElementGetTrainingElements (bool includeVerificationPoints)
 Returns a list of all neural training elements. More...
 
List< SampledDataElementGetTrainingElements (bool includeVerificationPoints, bool includeNonVerificationPoints)
 Returns a list of all neural training elements. More...
 
void TestClosestPoints (int numClosestPoints, bool includeVerificationPoints, bool printByComponents, params IVector[] points)
 For each point in the specified array, the training points are sorted according to the distance to this point, and data for the specified number of closest points are written. More...
 
void TestClosestPoints (int numClosestPoints, bool includeVerificationPoints, bool printByComponents, bool printIndividualPointsComp, params IVector[] points)
 For each point in the specified array, the training points are sorted according to the distance to this point, and data for the specified number of closest points are written. More...
 
void TestClosestPoints (int numClosestPoints, bool includeVerificationPoints, bool printByComponents, params SampledDataElement[] points)
 For each point (training element) in the specified array, the training points are sorted according to the distance to this point, and data for the specified number of closest points are written. More...
 
void TestClosestPoints (int numClosestPoints, bool includeVerificationPoints, bool printByComponents, bool printIndividualPointsComp, params SampledDataElement[] points)
 For each point (training element) in the specified array, the training points are sorted according to the distance to this point, and data for the specified number of closest points are written. More...
 
void TrainANN (int annType, int NumNeurons, int MaxEpochs, int EpochsInBundle, double LearnignRate, double Momentum, double InputSafetyFactor, double OutputSafetyFactor, double PercentVerificationPoints)
 Train the artificial neural network. More...
 
void SaveSensitivityCSV ()
 Saves sensitivity test in csv file. More...
 
- Public Member Functions inherited from IG.Lib.LoadableScriptShellBase
 LoadableScriptShellBase ()
 Constructor. More...
 
virtual bool RepairSimulationParameters (IVector parameters)
 Repairs simulation parameters, if necessary, in such a way that values are consistent with simuation data (e.g. spacing of nodes). More...
 
virtual void SimulatorCalculateResponse (IResponseEvaluatorVectorSimple simulator, IVector inputParameters, ref IVector outputValues)
 Calculates vector response by the specified simulator, and stores output values to the specified vector variable. More...
 
void SimulatorCalculateResponse (IVector parameters, ref IVector outputValues)
 Calculates vector response by the main simulator of the script, and stores output values to the specified vector variable. More...
 
- Public Member Functions inherited from IG.Lib.LoadableScriptOptShellBaseControllable
 LoadableScriptOptShellBaseControllable ()
 Creates a LoadableScriptOptBase object. More...
 
- Public Member Functions inherited from IG.Lib.LoadableScriptOptBase
 LoadableScriptOptBase ()
 Creates the LoadableScriptOptBase object. More...
 
abstract void Analyse (IAnalysisResults anRes)
 Performs direct analysis for optimization problems. This method must be overridden in derived classes where one wants to have direct analysis defined. More...
 
- Public Member Functions inherited from IG.Lib.LoadableScriptBase
 LoadableScriptBase ()
 Argument-less constructor. If argument-less constructor is called then initialization is not performed and will be performed later. More...
 
string Run (string[] arguments)
 Performs the action of this object. Override this in derived classes! More...
 
void Initialize (string[] arguments)
 Initializes the object. If not called explicitly, this method is automatically called at the first call to the Run method. More...
 
virtual string Script_DefaultInitialize (string[] arguments)
 Default initialization method for scripts. More...
 
virtual string Script_DefaultRun (string[] arguments)
 Default run method for the script. Can be used when only installed commands are run by hte script. More...
 
virtual
ICommandLineApplicationInterpreter 
Script_CreateInterpreterWithoutCommands ()
 Creates and returns an interpreter that can be used as script's internal interpreter for running script's commands. More...
 
delegate string Script_CommandDelegate (string[] args)
 Delegate for commands that are installed on script's internal interpreter (property Script_Interpreter). More...
 
void Script_AddCommand (string commandName, Script_CommandDelegate command, string helpString)
 Adds a new internal script command under specified name to the internal interpreter of the current script object. More...
 
virtual void Script_AddCommand (ICommandLineApplicationInterpreter interpreter, SortedList< string, string > helpStrings, string commandName, Script_CommandDelegate command, string helpString)
 Adds a new internal script command under specified name to the internal interpreter of the current script object. More...
 
string Script_GetHelpString (string scriptCommandName)
 Returns help string for internal script command with specified name, or null if help string is not installed for such a command. More...
 
void Script_PrintCommandsHelp ()
 Prits help for the installed internal commands of the script. More...
 
virtual bool Script_ContainsCommand (string commandName)
 Returns true if the internal script's interpreter contains a command with specified name, false otherwise. More...
 
virtual bool Script_ContainsScriptCommand (string commandName)
 Returns true if the specified command is script command (i.e. its first argument is command-name and it is run through the Script_CommandAdapter object). More...
 
virtual void Script_RemoveCommand (string commandName)
 Removes the specified internal script command from the internal interpreter of the current scripting object. More...
 
virtual void Script_RemoveAllCommands ()
 Removes ALL internal script commands from the internal interpreter of the current scripting object. More...
 
string Script_Run (string[] arguments)
 Runs internal script command. More...
 
string Script_Run (string commandName, params string[] otherArguments)
 Runs internal script command. More...
 
virtual void Script_PrintArguments (string messageString, string[] arguments)
 Prints the specified array of string arguments (usually passed as command-line arguments). More...
 

Public Attributes

const string ConstPrepareData = "PrepareData"
 Command name for prepairing data (creating data definition files). More...
 
const string ConstHelpPrepareData
 
const string ConstKillJMat = "KillJMat"
 Command name for killing eventually any running instances of JMatPro. More...
 
const string ConstHelpKillJMat
 
const string ConstIsJMatRunning = "IsJMatRunning"
 Command that checks whether JMatPro is currently running, and prints this out. More...
 
const string ConstHelpIsJMatRunning
 
const string ConstCalculateMaterial = "CalculateMaterial"
 Command name for calculating material properties at specific material parameters that are read from a JSON vector file. More...
 
const string ConstHelpCalculateMaterial
 
const string ConstCalculateMaterialDef = "CalculateMaterialDef"
 Command name for calculating material properties at specific material parameters that are read from a JSON data definition file (default input values are taken as material parameters). More...
 
const string ConstHelpCalculateMaterialDef
 
const string ConstCalculateMaterialsRandom = "CalculateRandomMaterials"
 Command name for calculating material properties at specific number of random material parameter sets that are uniformly randomly distributed. More...
 
const string ConstHelpCalculateMaterialsRandom
 
const string ConstWriteMaterialStatistics = "WriteMaterialStatistics"
 Command name for writing material calculation statistics. More...
 
const string ConstHelpWriteMaterialStatistics
 
const string ConstWriteMaterialsCalculated = "WriteCalculated"
 Command name for writing information about successfully calculated materials. More...
 
const string ConstHelpWriteMaterialsCalculated
 
const string ConstReleaseAbandonedMutex = "ReleaseMutex"
 Command name for releasing abandoned mutex. More...
 
const string ConstHelpReleaseAbandonedMutex
 
const string ConstClearBusyFlags = "ClearBusyFlags"
 Command name for clearing the busy flags for materials whose directories exist in the data root directory. More...
 
const string ConstHelpClearBusyFlags
 
const string ConstRetryCalculateMaterialProperties = "RetryCalculateMaterial"
 Command name for retrying calculation of material properties. More...
 
const string ConstHelpRetryCalculateMaterialProperties
 
const string ConstMoveMaterialDirectoriesMaterialCalculated = "MoveCalculated"
 Command name for moving to the appropriate storage the directories where material properties were successfully calculated. More...
 
const string ConstHelpMoveMaterialDirectoriesMaterialCalculated
 
const string ConstMoveMaterialDirectoriesBusyFlagSet = "MoveBusy"
 Command name for moving to the appropriate storage the directories where busy flag remained set. More...
 
const string ConstHelpMoveMaterialDirectoriesBusyFlagSet
 
const string ConstMoveMaterialDirectoriesTimedout = "MoveTimedout"
 Command name for moving to the appropriate storage the directories where material properties calculation has timed out. More...
 
const string ConstHelpMoveMaterialDirectoriesTimedout
 
const string ConstMoveMaterialDirectoriesCalculationFailed = "MoveFailed"
 Command name for moving to the appropriate storage the directories where calculation of material properties failed. More...
 
const string ConstHelpMoveMaterialDirectoriesCalculationFailed
 
const string ConstMoveMaterialDirectoriesDataCorrupted = "MoveCorrupted"
 Command name for moving to the appropriate storage the directories where material data is corrupted (e.g. material parameters are not properly written). More...
 
const string ConstHelpMoveMaterialDirectoriesDataCorrupted
 
const string ConstMoveMaterialDirectoriesAll = "MoveAll"
 Command name for moving to the appropriate storage directories all the material directories that belong to the specific JMatPro file manager. More...
 
const string ConstHelpMoveMaterialDirectoriesAll
 
const string ConstSaveSettings = "SaveSettings"
 Command name for moving to the appropriate storage the directories where busy flag remained set. More...
 
const string ConstHelpSaveSettings
 
const string ConstTestRestart = "TestRestart"
 Command name for moving to the appropriate storage the directories where busy flag remained set. More...
 
const string ConstHelpTestRestart
 
const string ConstTestMaterialResults = "TestMaterialResults"
 Command name for moving to the appropriate storage the directories where busy flag remained set. More...
 
const string ConstHelpTestMaterialResults
 
- Public Attributes inherited from IG.Script.LoadableScriptShellNeuralIT
const string ConstTrainNetwork = "TrainNetwork"
 Comamnd name for training the network. More...
 
const string ConstHelpTrainNetwork = "Trains NN on basis of standard data. Args: <numLayers> <numNeurons>"
 
const string ConstTrainParallelExample = "TrainParallel"
 Command name for parallel training of neural network. More...
 
const string ConstHelpTrainParallelExample = "Performs multiple trainings of neural networks at different parameters in parallel."
 
const string ConstPlotConvergence = "plotconvergence"
 Comamnd name for plotting convergence errors. More...
 
const string ConstHelpPlotConvergence = "Plots convergence errors of parallel trainings. Args: "
 
const string ConstPlotTrainingTime = "plottrainingtime"
 Comamnd name for plotting training time. More...
 
const string ConstHelpPlotTrainingTime = "Plots training times of parallel trainings. Args: "
 
const string ConstPlotVerificationResponse = "PlotVerificationResponse"
 Comamnd name for testing network response for verification points(plots, etc.). More...
 
const string ConstHelpVerificationResponse = "Plots verification response. "
 
const string ConstPlotTrainingResponse = "PlotTrainingResponse"
 Comamnd name for testing network response for verification points(plots, etc.). More...
 
const string ConstHelpTrainingResponse = "Plots training response. "
 
const string ConstPlotVerificationAndTrainingPoints = "plotverificationandtrainingpoints"
 Comamnd name for testing network response for verification points on line for all Inputs/outputs. More...
 
const string ConstHelpPlotVerificationAndTrainingPoints = "Plots network response for verification and training points. "
 
const string ConstPlotNetworkResponseOnLineAll = "PlotNetworkResponseOnLineAll"
 Comamnd name for testing network response for verification points on line for all Inputs/outputs. More...
 
const string ConstHelpNetworkResponseOnLineAll = "Plots network response for points on line from p1 to p2. "
 
const string ConstPlotNetworkCenteredPoint = "PlotNetworkResponseCenteredPoint"
 Comamnd name for testing network response for centered point from verification or training points for all Inputs/outputs. More...
 
const string ConstHelpPlotNetworkCenteredPoint = "Plots network response for centered point from verification or training set. "
 
const string ConstSensitivity = "Sensitivity"
 Comamnd name for testing network response for centered point from verification or training points for all Inputs/outputs. More...
 
const string ConstHelpSensitivity = "Executes sensitivity test. "
 
int ParallelNumServersDefault = 4
 
int ParallelMaxEnqueuedDefault = 10
 
double LearningRateFrom = 0.05
 Learning rate from number. More...
 
double LearningRateTo = 0.8
 Learning rate to number. More...
 
int NumLearningRate = 4
 Number of learning rates in selected region. More...
 
double MomentumFrom = 0.1
 Momentum from number. More...
 
double MomentumTo = 0.6
 Momentum to number. More...
 
int NumMomentum = 4
 Number of momentum in selected region. More...
 
double AlphaFrom = 1.2
 Alpha value from number. More...
 
double AlphaTo = 1.8
 Alpha value to number. More...
 
int NumAlpha = 4
 Number of alpha values in selected region. More...
 
int MaxEpochs = 1000
 Max number of epochs. More...
 
int EpochBundle = 100
 Number of epochs in bundle. More...
 
double ToleranceRMS = 0.01
 Maximum tolerance for RMS. More...
 
int NumHiddenLayers = 1
 Number of hidden layer in ANN. More...
 
int[] NumHiddenNeurons = new int[] { 10 }
 Number of nwueons in each hidden layer. More...
 
double InputBoundSafetyFactor = 1.3
 Safety factor for input bound. More...
 
double OutputBoundSafetyFactor = 1.3
 Safety factor for output bound. More...
 
bool allReadFromFile = false
 
int ANNType = 1
 
int NumNeuronsHidden1 = 40
 
int NumNeuronsHidden2 = 0
 
double LearnignRate = 0.3
 
double Momentum = 0.6
 
double AlphaValue = 1.0
 
double RatioVerificationPoints = 0.05
 
bool showErrorPercentages = false
 
bool verificationPointsFromFile = false
 
bool enableLabels = true
 
- Public Attributes inherited from IG.Script.LoadableScriptShellNeuralITOriginalBase
const string ConstTest = "Test"
 Comamnd name for test. More...
 
const string ConstHelpTest = "Test of functionality."
 
const string ConstCustom = "Custom"
 Comamnd name for test. More...
 
const string ConstHelpCustom = "Custom command that can be quickly modified as needed, for performing."
 
const string ConstRunParallel = "RunParallel"
 Comamnd name for running parallel simulations. More...
 
const string ConstHelpRunParallel = "Runs parallel simulations. Args: numThreads numRunsPerThread"
 
const string ConstCollectParallel = "collectparallel"
 Comamnd name for running parallel simulations. More...
 
const string ConstHelpCollectParallel = "Collects results of parallel simulations. Args: numThreads"
 
const string ConstCreateDistortedModelData = "CreateDistortedModelData"
 Comamnd name for creating distorted model data. More...
 
const string ConstHelpCreateDistortedModelData
 
const string ConstStochasticCreateInput = "StochasticCreateInput"
 Command name for creating input data for analysis how stochastic variables influence outputs. More...
 
const string ConstHelpStochasticCreateInput
 
const string ConstStochasticInfluence = "StochasticInfluence"
 Command name for calculating influence of stochastic Gaussian distributed input variables on outputs. More...
 
const string ConstHelpStochasticInfluence
 
const string ConstCreateBinarySampledData = "CreateBinarySampledData"
 Comamnd name for saving model's sampled data in binary form. More...
 
const string ConstHelpCreateBinarySampledData
 
const string ConstRestoreBinarySampledData = "RestoreBinarySampledData"
 Comamnd name for restoring sampled data in binary form and storing it in JSON. More...
 
const string ConstHelpRestoreBinarySampledData
 
string ParallelResultsFilename = "ParallelResults"
 
int ParSimNumRuns = 2
 Number of runs of simulator in each parallel thread. More...
 
int ParSimNumThreads = 2
 Number of jobs that can be executed in parallel. More...
 
int ParSimSavingFrequency = 4
 Specifies how often the results are saved. More...
 
string ParSimResultFilename = "GatheredNeuralTrainingData.json"
 
bool saveGraphs = false
 
- Public Attributes inherited from IG.Script.LoadableScriptShellNeuralBase
const string ConstTest = "Test"
 Comamnd name for test. More...
 
const string ConstHelpTest = "Test of functionality."
 
const string ConstCustom = "Custom"
 Comamnd name for test. More...
 
const string ConstHelpCustom = "Custom command that can be quickly modified as needed, for performing."
 
const string ConstRunParallel = "RunParallel"
 Comamnd name for running parallel simulations. More...
 
const string ConstHelpRunParallel = "Runs parallel simulations. Args: numThreads numRunsPerThread"
 
const string ConstCollectParallel = "collectparallel"
 Comamnd name for running parallel simulations. More...
 
const string ConstHelpCollectParallel = "Collects results of parallel simulations. Args: numThreads"
 
const string ConstCreateDistortedModelData = "CreateDistortedModelData"
 Comamnd name for testing network response for centered point from verification or training points for all Inputs/outputs. More...
 
const string ConstHelpCreateDistortedModelData
 
string ParallelResultsFilename = "ParallelResults"
 
int ParSimNumRuns = 2
 Number of runs of simulator in each parallel thread. More...
 
int ParSimNumThreads = 2
 Number of jobs that can be executed in parallel. More...
 
int ParSimSavingFrequency = 4
 Specifies how often the results are saved. More...
 
string ParSimResultFilename = "GatheredNeuralTrainingData.json"
 
bool saveGraphs = false
 
- Public Attributes inherited from IG.Lib.LoadableScriptBase
const string ConstDefaultHelp = "Help"
 Default command name for help. More...
 
const string ConstHelpDefaultUniversal = "?"
 Universal name of the help command. More...
 
const string ConstDefaultTestScrip = "TestScript"
 Default command name for test method. More...
 

Protected Member Functions

override void InitializeThis (string[] arguments)
 Initializes the current object. More...
 
override string RunThis (string[] arguments)
 Runs action of the current object. More...
 
override string Script_CommandTestScript (string[] arguments)
 Override the TestScript runnable method in order to print some additional information. More...
 
- Protected Member Functions inherited from IG.Script.LoadableScriptShellNeuralIT
override void InitializeThis (string[] arguments)
 Inializes the current script object. More...
 
override void LoadJson (string path, ref INeuralApproximator network)
 Loads the neural network approximator from the specified file. More...
 
override void SaveJson (INeuralApproximator approximator, string trainedNetworkFilePath)
 Saves the specified trained network to a file. More...
 
override INeuralApproximator CreateApproximator (int annType=2)
 Creates and returns a new neural network approximator, with the basic properties pre-set to default values, dependent on the type of the requires approximator. More...
 
virtual NeuralApproximatorBase CreateParallelApproximator ()
 Creates a parallel approximator for parallel training and comparison of training resultw at different parameters. More...
 
virtual NeuralTrainingParameters TrainNetwork (NeuralTrainingParameters parameters)
 Trains network. Used as execution delegate on job containers. More...
 
virtual void TrainSerial ()
 Performs training of neural networks with the specified parameters in non-parallel way. More...
 
virtual void TrainParallel ()
 Performs parallel training of neural networks with the specified parameters. More...
 
virtual void TrainParallel (bool isParallel)
 Performs parallel training of neural networks with the specified parameters. More...
 
- Protected Member Functions inherited from IG.Script.LoadableScriptShellNeuralITOriginalBase
override void InitializeThis (string[] arguments)
 Inializes the current script object. More...
 
virtual void PrintInternalCommandAndArguments (string[] arguments)
 Prints internal command being executed and its actual arguments More...
 
virtual void GetSimulationInputDefault (ref IVector result)
 Gets the vector of default values of simulation parameters and stores it in the specified vector. More...
 
virtual void GetSimulationInputMin (ref IVector result)
 Gets the vector of lower bounds on simulation parameters and stores it in the specified vector. More...
 
virtual void GetSimulationInputMax (ref IVector result)
 Gets the vector of upper bounds on simulation parameters and stores it in the specified vector. More...
 
virtual void ParSimPrepareDirectories (int numThreads)
 Prepares data for the specified number of parallel execution threads. More...
 
virtual void ParSimWaitAllCompletion ()
 Waits until all parallel jobs complete. More...
 
virtual void ParSimAsyncCallback (IAsyncResult ar)
 Callback method for asynchronous runs. More...
 
virtual string ParSimGetDirectoryExtension (int threadIndex)
 Returns directory extension for data directory used in the specified parallel calculation thread. More...
 
virtual void GetNeuralInputDefault (ref IVector result)
 Gets the vector of default values of neural parameters and stores it in the specified vector. More...
 
virtual void GetNeuralInputMin (ref IVector result)
 Gets the vector of lower bounds on neural parameters and stores it in the specified vector. More...
 
virtual void GetNeuralInputMax (ref IVector result)
 Gets the vector of upper bounds on neural parameters and stores it in the specified vector. More...
 
virtual void GetRandomNeuralInputFromDataDefinition (IRandomGenerator rand, ref IVector result)
 Generates a random vector of neural input parameters whose elements (components) lie within the lower and upper bounds on parameters, and stores it to the specified vector. More...
 
- Protected Member Functions inherited from IG.Lib.LoadableScriptShellBase
virtual void CreateNewSimulator (string simulatorPath, ref IResponseEvaluatorVectorSimple simulator)
 Creates a new simulator that uses the specified simulator directory, and stores it to the specified variable. More...
 
- Protected Member Functions inherited from IG.Lib.LoadableScriptBase
delegate string CommandMethod (string commandName, string[] args)
 Delegate for internal command methods. More...
 
ICommandLineApplicationInterpreter Script_CreateInterpreter ()
 Creates and returns an interpreter that can be used as script's internal interpreter for running script's commands. More...
 
virtual string Script_CommandHelp (string[] arguments)
 Prints help. More...
 

Protected Attributes

SimJMatProFileManagerBase _jMatFm
 
- Protected Attributes inherited from IG.Script.LoadableScriptShellNeuralIT
int numPointsOnLine = 5
 
bool maxDistancePoints = true
 
bool enableTrainingPoint = false
 
bool enableVerificationPoint = true
 
- Protected Attributes inherited from IG.Script.LoadableScriptShellNeuralITOriginalBase
IVector _simulationInputDefault
 
IVector _simulationInputMin
 
IVector _simulationInputMax
 
IBoundingBox _simulationInputBounds
 
string _parallelResultsFilename = "ParallelResults"
 
string _parallelResultsFileExtension = ".json"
 
List< IAsyncResult > ParallelResults
 
object ParSimProcessDelayLock = new object()
 
int ParSimProcessDelayMilliseconds = 500
 Minimal delay between two successive launches of simulator processes, in milliseconds. This delay is introduced in order to prevent unusual errors that occur when running two simulator processes at approcimately the same time (although they use completely separate data directory structures). More...
 
List< IVector_sensitivityResultsVerification
 
List< IVector_sensitivityResultsTraining
 
INeuralApproximator _trainedNetwork
 
SampledDataSet _trainingData
 
SampledDataSet _verificationData
 
IVector _neuralInputDefault
 
IVector _neuralInputMin
 
IVector _neuralInputMax
 
IBoundingBox _neuralInputBounds
 
const string _binaryTrainingDataExtension = ".bin"
 
const string _restoredTrainingDataExtension = ".jsonrestored"
 
- Protected Attributes inherited from IG.Script.ScriptShellNeuralWithSimulatorManagers
string _simCastingRobertRootDirectory
 
string _simCastingRobertProjectName
 
SimCastingRobertFileManager _simCastingRobertFM
 
string _simConvectionRobertRootDirectory
 
string _simConvectionRobertProjectName
 
ConvectionRobertFileManager _simConvectionRobertFM
 
ConvectionRev1RobertFileManager _simConvectionRev1RobertFM
 
string _simKosecDirectoryRelativePath = "Code"
 
string _simKosecDirectory = null
 
SimKosecFileManagerBase _simKosecFM
 
- Protected Attributes inherited from IG.Script.LoadableScriptShellNeuralBase
IVector _simulationInputDefault
 
IVector _simulationInputMin
 
IVector _simulationInputMax
 
IBoundingBox _simulationInputBounds
 
string _parallelResultsFilename = "ParallelResults"
 
string _parallelResultsFileExtension = ".json"
 
List< IAsyncResult > ParallelResults
 
object ParSimProcessDelayLock = new object()
 
int ParSimProcessDelayMilliseconds = 500
 Minimal delay between two successive launches of simulator processes, in milliseconds. This delay is introduced in order to prevent unusual errors that occur when running two simulator processes at approcimately the same time (although they use completely separate data directory structures). More...
 
List< IVector_sensitivityResultsVerification
 
List< IVector_sensitivityResultsTraining
 
INeuralApproximator _trainedNetwork
 
SampledDataSet _trainingData
 
SampledDataSet _verificationData
 
IVector _neuralInputDefault
 
IVector _neuralInputMin
 
IVector _neuralInputMax
 
IBoundingBox _neuralInputBounds
 
- Protected Attributes inherited from IG.Lib.LoadableScriptShellBase
IResponseEvaluatorVectorSimple _simulator
 
string _projectName
 
string _simulationName
 
- Protected Attributes inherited from IG.Lib.LoadableScriptOptBase
StopWatch1 _timer = null
 
bool _checkOptimizationDirectoryExistence = true
 Whether to check existence of optimization directory when set. Also applies to working directory. More...
 
- Protected Attributes inherited from IG.Lib.LoadableScriptBase
string _embeddedCommandName = null
 
int _outputLevel = DefaultOutputLevel
 
ICommandLineApplicationInterpreter _script_interpreter
 

Properties

override string WorkingDirectory [get, set]
 Working directory for this and derived scripts is teh same as optimization directory. More...
 
SimJMatProFileManagerBase JMatFM [get, set]
 JMatPro file manager that is currently in use. More...
 
- Properties inherited from IG.Script.LoadableScriptShellNeuralIT
virtual List
< NeuralTrainingParameters
TrainingParametersAndResults [get]
 List of training parameters for which training should be performed. More...
 
virtual string TrainingParametersPath [get]
 Path to the default location lwhere training parameters and convergence results from multiple training attempts are stored. More...
 
virtual string TrainingLimitsPath [get]
 Path to the default location lwhere training limits are stored. More...
 
virtual string TrainingResultsPath [get]
 Path to the default location lwhere training complete results are stored. More...
 
virtual string TrainingResultsCSVPath [get]
 Path to the default location lwhere training complete results are stored. More...
 
virtual string OptimalTrainingParametersPath [get]
 Path to the default location where optimal training parameters for the current problem are stored. More...
 
virtual string AdditionalTrainingParametersFilename [get, set]
 Eventual relative path of an additional file name where results are stored. More...
 
int ParallelNumServers [get, set]
 Number of parallel servers that will be used for parallel execution of jobs. More...
 
int ParallelMaxEnqueued [get, set]
 Maximal number of enqueued jobs when performing parallel execution of jobs. More...
 
int ParallelSleepTimeMs [get, set]
 Sleeping time in milliseconds. More...
 
bool ParallelIsServerMode [get, set]
 Whether servers will operate in server mode (true) or by running each job in a new thread (false). More...
 
int ParallelClientOutputLevel [get, set]
 Client's output level when executing parallel jobs. More...
 
int ParallelOutputLevel [get, set]
 Output level for parallel dispatcher, servers and job containers when executing parallel jobs. More...
 
bool ParallelIsTestMode [get, set]
 Specifies whether parallel jobs will be executing in testing mode (where e.g. delay times apply). More...
 
double ParallelDelayTimeSeconds [get, set]
 Delay in seconds used in parallel execution. This is useful only for testing purposes, default is 0. More...
 
double ParallelDelayTimeRelativeError [get, set]
 Relative variation in delay time used in parallel execution. This is useful only for testing purposes, default is 0. More...
 
virtual int ParallelSavingFrequency [get, set]
 Frequency of saving the results of parallel execution: More...
 
- Properties inherited from IG.Script.LoadableScriptShellNeuralITOriginalBase
override int NumOptimizationParameters [get, protected set]
 Number of optimization parameters. More...
 
override int NumOptimizationConstraints [get, protected set]
 Number of optimization constraints. More...
 
virtual InputOutputDataDefiniton SimulationDataDefinition [get]
 Simulation data definition (input and output used by simulator). More...
 
virtual int NumSimulationParameters [get, protected set]
 Number of simulation input parameters. More...
 
virtual int NumSimulationOutputs [get, protected set]
 Number of simulation output values. More...
 
virtual IBoundingBox SimulationInputBounds [get, protected set]
 Bounds on simulation input parameters. More...
 
string ParallelResultsFileExtension [get, protected set]
 
virtual
NeuraApproximationFileManager 
NeuralFM [get]
 File manager that provides access to trained neural network and related data. More...
 
virtual INeuralApproximator TrainedNetwork [get, protected set]
 Trained neural network. More...
 
virtual List< IVectorSensitivityVerificationResults [get, protected set]
 
virtual List< IVectorSensitivityTrainingResults [get, protected set]
 
virtual INeuralApproximator XXX_TrainedNetwork [get, protected set]
 Trained neural network. More...
 
virtual InputOutputDataDefiniton NeuralDataDefinition [get, protected set]
 Neural data definition. More...
 
virtual SampledDataSet TrainingData [get, set]
 
virtual SampledDataSet VerificationData [get, set]
 
virtual int NumNeuralParameters [get, protected set]
 Number of neural network input parameters. More...
 
virtual int NumNeuralOutputs [get, protected set]
 Number of neural network output values. More...
 
virtual IBoundingBox NeuralInputBounds [get, protected set]
 Bounds on neural input parameters. More...
 
virtual SampledDataSet NeuralTrainingData [get]
 Gets the training data. More...
 
virtual int NumAllTrainingPoints [get]
 Gets number of all training points, including verification points. More...
 
virtual IVector SomeNeuralInput [get]
 Returns some vector of input parameters that is within the range. More...
 
virtual IVector NeuralInputFromFile [get]
 Vector of input parameters read form the file. More...
 
- Properties inherited from IG.Script.ScriptShellNeuralWithSimulatorManagers
virtual string SimCastingRobertRootDirectory [get, protected set]
 Root directory for casting simulator. More...
 
virtual string SimCastingRobertProjectName [get, protected set]
 Project name for interfacing Robert Vertnik's casting simulator. More...
 
virtual string SimCastingRobertSimulationName [get, protected set]
 Simulation name for interfacing Robert Vertnik's casting simulator. More...
 
virtual SimCastingRobertFileManager SimCastingRobertFM [get, set]
 File manager for interfacing Robert Vertnik's casting simulator. Lazy evaluation: The object is created when first accessed, if possible. For this, ProjectName, SimulationName and SimCastingRobertRootDirectory must be defined. More...
 
virtual string SimConvectionRobertRootDirectory [get, protected set]
 Root directory for Convection simulator. More...
 
virtual string SimConvectionRobertProjectName [get, protected set]
 Project name for interfacing Robert Vertnik's Convection simulator. More...
 
virtual string SimConvectionRobertSimulationName [get, protected set]
 Simulation name for interfacing Robert Vertnik's Convection simulator. More...
 
virtual ConvectionRobertFileManager SimConvectionRobertFM [get, set]
 File manager for interfacing Robert Vertnik's casting simulator. Lazy evaluation: The object is created when first accessed, if possible. For this, ProjectName, SimulationName and SimCastingRobertRootDirectory must be defined. More...
 
virtual
ConvectionRev1RobertFileManager 
SimConvectionRev1RobertFM [get, set]
 File manager for interfacing Robert Vertnik's casting simulator. Lazy evaluation: The object is created when first accessed, if possible. For this, ProjectName, SimulationName and SimCastingRobertRootDirectory must be defined. More...
 
virtual string SimKosecDirectoryRelativePath [get, set]
 Relative path of the directory that contains Kosec' simulation data, with respect to optimization directory. More...
 
string SimKosecDirectory [get, set]
 Path so directory containing Kosec' simulator data. More...
 
virtual SimKosecFileManagerBase SimKosecFM [get, protected set]
 File manager of simulatior of Gregor Kosec. More...
 
- Properties inherited from IG.Script.LoadableScriptShellNeural
override
IResponseEvaluatorVectorSimple 
Simulator [get, protected set]
 
override int NumOptimizationParameters [get, protected set]
 Throws NotImplementedException. More...
 
override int NumOptimizationConstraints [get, protected set]
 Throws NotImplementedException. More...
 
- Properties inherited from IG.Script.LoadableScriptShellNeuralBase
abstract int NumOptimizationParameters [get, protected set]
 Number of optimization parameters. More...
 
abstract int NumOptimizationConstraints [get, protected set]
 Number of optimization constraints. More...
 
virtual InputOutputDataDefiniton SimulationDataDefinition [get]
 Simulation data definition (input and output used by simulator). More...
 
virtual int NumSimulationParameters [get, protected set]
 Number of simulation input parameters. More...
 
virtual int NumSimulationOutputs [get, protected set]
 Number of simulation output values. More...
 
virtual IBoundingBox SimulationInputBounds [get, protected set]
 Bounds on simulation input parameters. More...
 
string ParallelResultsFileExtension [get, protected set]
 
virtual
NeuraApproximationFileManager 
NeuralFM [get]
 File manager that provides access to trained neural network and related data. More...
 
virtual INeuralApproximator TrainedNetwork [get, protected set]
 Trained neural network. More...
 
virtual List< IVectorSensitivityVerificationResults [get, protected set]
 
virtual List< IVectorSensitivityTrainingResults [get, protected set]
 
virtual INeuralApproximator XXX_TrainedNetwork [get, protected set]
 Trained neural network. More...
 
virtual InputOutputDataDefiniton NeuralDataDefinition [get, protected set]
 Neural data definition. More...
 
virtual SampledDataSet TrainingData [get, set]
 
virtual SampledDataSet VerificationData [get, set]
 
virtual int NumNeuralParameters [get, protected set]
 Number of neural network input parameters. More...
 
virtual int NumNeuralOutputs [get, protected set]
 Number of neural network output values. More...
 
virtual IBoundingBox NeuralInputBounds [get, protected set]
 Bounds on neural input parameters. More...
 
virtual SampledDataSet NeuralTrainingData [get]
 Gets the training data. More...
 
virtual int NumAllTrainingPoints [get]
 Gets number of all training points, including verification points. More...
 
virtual IVector SomeNeuralInput [get]
 Returns some vector of input parameters that is within the range. More...
 
virtual IVector NeuralInputFromFile [get]
 Vector of input parameters read form the file. More...
 
- Properties inherited from IG.Lib.LoadableScriptShellBase
abstract
IResponseEvaluatorVectorSimple 
Simulator [get, protected set]
 Simulator that is used to calculate vector response. More...
 
virtual bool SimulatorSuppressOutput [get, set]
 A flag indicating whether simulators should suppress output or not, default is false. More...
 
virtual string ProjectName [get, protected set]
 Name of the current project, used in some simulation and other interfaces. More...
 
virtual string SimulationName [get, protected set]
 Name of the current simulation, used in some simulation and other interfaces. More...
 
- Properties inherited from IG.Lib.LoadableScriptOptShellBaseControllable
bool IsLoadable [get, set]
 Either or not the script can be dynamically loaded. More...
 
bool IsRunnable [get, set]
 Either or not the script can be run (some scripts only support other tasks). More...
 
- Properties inherited from IG.Lib.LoadableScriptOptBase
StopWatch1 Timer [get]
 
virtual IRandomGenerator Random [get, protected set]
 Random generator used by the current object. More...
 
virtual string OptimizationDirectory [get, set]
 Optimization directory. This directory is a base directory for data used optimization and neural network - based approximation servers and for other directories that contain data for specific tasks. More...
 
virtual string WorkingDirectory [get, set]
 Working directory. This directory is a base directory for data used by the script. It is usually obtained as parent directory of the optimization directory. More...
 
virtual IAnalysis Analysis [get, protected set]
 Direct analysis object used in optimization. Initialized when first accessed with the embedded class, whose analysis function calls Analyse(...). More...
 
- Properties inherited from IG.Lib.LoadableScriptBase
string EmbeddedCommandName [get, set]
 Command that was used to launch the current embedded application script. More...
 
object Lock [get]
 This object's central lock object to be used by other object. Do not use this object for locking in class' methods, for this you should use InternalLock. More...
 
string[] InitializationArguments [get, set]
 Arguments used by the initialization method. WARNING: arguments can only be set before initialization is performed. Initialization is performed either implicitly at the first call to the Run method or explicitly by calling the Initialize method. More...
 
virtual bool IsInitialized [get, protected set]
 Whether the object has been initialized or not. More...
 
static int DefaultOutputLevel [get, set]
 
int OutputLevel [get, set]
 Level of output to console produced by some operations of the current object. More...
 
virtual
ICommandLineApplicationInterpreter 
Script_Interpreter [get, protected set]
 Script's internal interpreter that takes care for execution of installed internal commands. More...
 
SortedList< string, string > Script_CommandHelpStrings [get]
 Contains help strings associated with script commands installed on interpreter. More...
 
- Properties inherited from IG.Lib.ILoadableScript
string EmbeddedCommandName [get, set]
 Command that was used to launch the current embedded application script. More...
 
string[] InitializationArguments [get, set]
 Arguments used by the initialization method. More...
 
bool IsInitialized [get]
 Whether the object has been initialized or not. More...
 
- Properties inherited from IG.Lib.ILockable
object Lock [get]
 
- Properties inherited from IG.Lib.ILoadableScriptC
bool IsLoadable [get, set]
 Either or not the script can be dynamically loaded. More...
 
bool IsRunnable [get, set]
 Either or not the script can be run (some scripts only support other tasks). More...
 
- Properties inherited from IG.Num.INeuralModel
INeuralApproximator TrainedNetwork [get]
 Traint artificial neural network. More...
 
InputOutputDataDefiniton NeuralDataDefinition [get]
 Neural data definition. More...
 

Additional Inherited Members

- Static Public Attributes inherited from IG.Script.LoadableScriptShellNeuralITOriginalBase
static string TrainedNetworkAlternativeLovation = null
 If different than null, this static property provides alternative location of the file which neural network approximator is resd from, in terms of path relative to optimization directory. More...
 
- Static Public Attributes inherited from IG.Script.LoadableScriptShellNeuralBase
static string TrainedNetworkAlternativeLovation = null
 If different than null, this static property provides alternative location of the file which neural network approximator is resd from, in terms of path relative to optimization directory. More...
 

Detailed Description

Script class for running JMatPro calculations and manipulating results.

Constructor & Destructor Documentation

IG.Script.S_12_09_jmatpro.S_12_09_jmatpro ( )
inline

Member Function Documentation

override void IG.Script.S_12_09_jmatpro.InitializeThis ( string[]  arguments)
inlineprotectedvirtual

Initializes the current object.

Reimplemented from IG.Script.LoadableScriptShellNeural.

override string IG.Script.S_12_09_jmatpro.RunThis ( string[]  arguments)
inlineprotectedvirtual

Runs action of the current object.

Parameters
argumentsCommand-line arguments of the action.

Reimplemented from IG.Script.LoadableScriptShellNeural.

override void IG.Script.S_12_09_jmatpro.Script_AddCommands ( ICommandLineApplicationInterpreter  interpreter,
SortedList< string, string >  helpStrings 
)
inlinevirtual

Adds commands to the internal interpreter.

Parameters
interpreterInterpreter where commands are executed.
helpStringsList containg help strings.

Reimplemented from IG.Script.LoadableScriptShellNeuralBase.

override string IG.Script.S_12_09_jmatpro.Script_CommandTestScript ( string[]  arguments)
inlineprotectedvirtual

Override the TestScript runnable method in order to print some additional information.

Parameters
argumentsScript arguments.
Returns
null.

Reimplemented from IG.Lib.LoadableScriptBase.

string IG.Script.S_12_09_jmatpro.CommandCustom ( string[]  args)
inline

Custom JMatPro operations (for development tasks and quick auxiliary tasks).

Parameters
AppArgumentsArguments.
Returns
Null.
string IG.Script.S_12_09_jmatpro.CommandPrepareData ( string[]  args)
inline

Prepares definition data for running the JMatPro material calculations and subsequent numerical simulations based on these results. Also prepares a template settings file and a file with input parameters (in two forms, as vector and as default values in definition data) that can be used as default material parameters.

Parameters
AppArgumentsCommand arguments.
Returns
null.

This method takes a definition that contains a supersset of all material parameters, and it takes definition o fprocess input parameters and output values. From these definitions, it generates material input parameter definitions

string IG.Script.S_12_09_jmatpro.CommandKillJmat ( string[]  args)
inline

Kills eventually running JMatPro process(es).

Parameters
AppArgumentsCommand arguments. First argument can be path to settings file.
Returns
null

References IG.Lib.Util.SleepSeconds().

string IG.Script.S_12_09_jmatpro.CommandIsJmatRunning ( string[]  args)
inline

Tells whether JMatPro is currently running.

Parameters
AppArgumentsCommand arguments. First argument can be path to settings file.
Returns
"true" if program is running, false if not.
string IG.Script.S_12_09_jmatpro.CommandCalculateMaterial ( string[]  args)
inline

Calculates material properties at specific parameters that are read from a json file as vector object.

Parameters
AppArgumentsCommand arguments.

First argument is the settings file (optional).

Second argument is path to the file containing material parameters. It can be relative to the working directory, relative to current directory, or absolute.

Returns
null
string IG.Script.S_12_09_jmatpro.CommandCalculateMaterialDef ( string[]  args)
inline

Calculates material properties at specific parameters that are read from a json file as data definition object where default input values are taken as parameters.

Parameters
AppArgumentsCommand arguments.

First argument is the settings file (optional).

Second argument is path to the file containing material parameters. It can be relative to the working directory, relative to current directory, or absolute.

Returns
null
string IG.Script.S_12_09_jmatpro.CommandCalculateMaterialsRandom ( string[]  args)
inline

Calculates material properties at a parameter sets that are chosen uniformly randomly within material parameter bounds. Second argument can specify the number of calculations, if not specified then default number is taken.

Parameters
AppArgumentsCommand arguments.

First argument is the settings file (optional).

Second argument (optional) specifies the number of calculations performed.

Returns
null
string IG.Script.S_12_09_jmatpro.CommandWriteMaterialStatistics ( string[]  args)
inline

Writes statistics about material properties calculation to the console and to the log file.

Data is obtained by checking all individual material directories that exist in the root material directory.

Data written include the number of successfully calculated materials, the number of materials for which calculation failed, and the number of materials where the busy flag is still set in their calculation directories.

Parameters
AppArgumentsCommand arguments.

First argument is the settings file (optional).

Second argument (optional) is boolean and specifies whether directory names are written for different chategories (in particular, for failed calculations and for directories where busy flag is currently set).

Returns
Number of successfully calcuated materials.

References IG.Lib.Util.ParseBoolean().

string IG.Script.S_12_09_jmatpro.CommandWriteMaterialsCalculated ( string[]  args)
inline

Prints (to console and log file) information about material directories where material properties were successfully calculated.

Parameters
AppArgumentsCommand arguments.

First argument is the settings file (optional).

Returns
Number of successfully calcuated materials.
string IG.Script.S_12_09_jmatpro.CommandReleaseAbandonedMutex ( string[]  args)
inline

Releases the file access locking mutex used by the JMatPro interface' file manager. Returns true if the mutex ha been abandoned and has thus actually been released. First argument is the path to the settings file used.

Parameters
AppArgumentsCommand arguments.

First argument is the settings file (optional).

Returns
"True" if mutex has been abandoned and has thus actually been released. false otherwise.
string IG.Script.S_12_09_jmatpro.CommandClearBusyFlags ( string[]  args)
inline

Clears the busy flags from all or from specified material calculation directories.

Parameters
AppArgumentsCommand arguments.

First argument is the settings file (optional).

Following argument(s) (optional) are paths to material directories where busy flag should be cleared. Paths can be specified relative to material data root (only directory names), relative to the working directory or absolute.

Returns
Number of directories where busy flag has been cleared.

References IG.Lib.UtilConsole.Read().

string IG.Script.S_12_09_jmatpro.CommandRetryCalculateMaterialProperties ( string[]  args)
inline

Retries calculation of material properties in all material calculation directories where calculation has not completed successfully, or from the specified material calculation directories.

Parameters
AppArgumentsCommand arguments.

First argument is the settings file (optional).

Following argument(s) (optional) are paths to material directories where recalculation is performed. Paths can be specified relative to material data root (only directory names), relative to the working directory or absolute.

Returns
Number of directories where material properties have been recalculated.
string IG.Script.S_12_09_jmatpro.CommandMoveMaterialDirectoriesMaterialCalculated ( string[]  args)
inline

Moves to the appropriate storage directory those material directories where material properties were successfully calculated.

Parameters
AppArgumentsCommand arguments.

First argument is the settings file (optional).

Returns
Number of moved material directories.
string IG.Script.S_12_09_jmatpro.CommandMoveMaterialDirectoriesBusyFlagSet ( string[]  args)
inline

Moves to the appropriate storage directory those material directories where busy flag remained set.

Parameters
AppArgumentsCommand arguments.

First argument is the settings file (optional).

Returns
Number of moved material directories.
string IG.Script.S_12_09_jmatpro.CommandMoveMaterialDirectoriesTimedout ( string[]  args)
inline

Moves to the appropriate storage directory those material directories where material properties calculation has timed out.

Parameters
AppArgumentsCommand arguments.

First argument is the settings file (optional).

Returns
Number of moved material directories.
string IG.Script.S_12_09_jmatpro.CommandMoveMaterialDirectoriesCalculationFailed ( string[]  args)
inline

Moves to the appropriate storage directory those material directories where calculation of material properties failed.

Parameters
AppArgumentsCommand arguments.

First argument is the settings file (optional).

Returns
Number of moved material directories.
string IG.Script.S_12_09_jmatpro.CommandMoveMaterialDirectoriesDataCorrupted ( string[]  args)
inline

Moves to the appropriate storage directory those material directories where material data is corrupted (e.g. material parameters are not properly written).

Parameters
AppArgumentsCommand arguments.

First argument is the settings file (optional).

Returns
Number of moved material directories.
string IG.Script.S_12_09_jmatpro.CommandMoveMaterialDirectoriesAll ( string[]  args)
inline

Moves all material directories to the appropriate storage directories.

Parameters
AppArgumentsCommand arguments.

First argument is the settings file (optional).

The second argument (optional, default is false) specifies whether directories where busy flag is set are also moved.

The third argument (optional, default is false) specifies whether directories where material properties have been successfully calculated are also moved.

Returns
Number of moved material directories.

References IG.Lib.Util.ParseBoolean().

string IG.Script.S_12_09_jmatpro.CommandSaveSettings ( string[]  args)
inline

Saves the settings that are read from the specified settings file. Purpose of this is to verify that all settings have been read correctly and as expected and are restored correctly when saving. For example, correct function of the include property in settings file can be verified by this.

Parameters
AppArgumentsCommand arguments.

First argument is the settings file and should be specified.

Second argument (optional) is name of the file where settings will be saved, relative to the working directory, relative to current directory. If not specified then default file name is taken (00testsettings.json).

Returns
null
string IG.Script.S_12_09_jmatpro.CommandTestRestart ( string[]  args)
inline

Tests functions related to restart procedures, including the mapping from material parameters to material directory name.

Parameters
AppArgumentsCommand arguments.
Returns
null.

References IG.Num.VectorBase.Compare(), IG.Num.VectorBase.LoadJson(), IG.Num.VectorBase.SaveJson(), and IG.Num.VectorBase.Subtract().

string IG.Script.S_12_09_jmatpro.CommandTestMaterialResults ( string[]  args)
inline

Checks material result file from the specified material directory (or from all successful & failed directories, if material directories are not specified) and writes basic information about the results, including whether results are uncorrupted.

Parameters
AppArgumentsCommand arguments. Arguments can contain material directories that are checked.
Returns
null.

Member Data Documentation

SimJMatProFileManagerBase IG.Script.S_12_09_jmatpro._jMatFm
protected
const string IG.Script.S_12_09_jmatpro.ConstPrepareData = "PrepareData"

Command name for prepairing data (creating data definition files).

const string IG.Script.S_12_09_jmatpro.ConstHelpPrepareData
Initial value:
=
@"Prepares data definitions for input parameters and output values,
also saves settings."
const string IG.Script.S_12_09_jmatpro.ConstKillJMat = "KillJMat"

Command name for killing eventually any running instances of JMatPro.

const string IG.Script.S_12_09_jmatpro.ConstHelpKillJMat
Initial value:
=
@"Kills any running instances of JMatPro. First argument can be settings file."
const string IG.Script.S_12_09_jmatpro.ConstIsJMatRunning = "IsJMatRunning"

Command that checks whether JMatPro is currently running, and prints this out.

const string IG.Script.S_12_09_jmatpro.ConstHelpIsJMatRunning
Initial value:
=
@"Checks whether JMatPro is running and prints this out. First argument can be settings file."
const string IG.Script.S_12_09_jmatpro.ConstCalculateMaterial = "CalculateMaterial"

Command name for calculating material properties at specific material parameters that are read from a JSON vector file.

const string IG.Script.S_12_09_jmatpro.ConstHelpCalculateMaterial
Initial value:
=
@"Calculates material properties at material parameters that are read as vector from a JSON file.
First argument is path to file manager settings (optional).
Second argument is path to the file containing material parameters, absolute or relative
to current directory or relative to working directory or unspecified for default path."
const string IG.Script.S_12_09_jmatpro.ConstCalculateMaterialDef = "CalculateMaterialDef"

Command name for calculating material properties at specific material parameters that are read from a JSON data definition file (default input values are taken as material parameters).

const string IG.Script.S_12_09_jmatpro.ConstHelpCalculateMaterialDef
Initial value:
=
@"Calculates material properties at material parameters that are read as data definition
from a JSON file (default input values are taken as input parameters).
First argument is path to file manager settings (optional).
Second argument is path to the file containing material parameters, absolute or relative
to current directory or relative to working directory or unspecified for default path."
const string IG.Script.S_12_09_jmatpro.ConstCalculateMaterialsRandom = "CalculateRandomMaterials"

Command name for calculating material properties at specific number of random material parameter sets that are uniformly randomly distributed.

const string IG.Script.S_12_09_jmatpro.ConstHelpCalculateMaterialsRandom
Initial value:
=
@"Calculates material properties at the specified number of sets of random material parameters.
First argument is the path to the settings file used.
Second argument (optional) is the number of random parameter sets where calculations are run."
const string IG.Script.S_12_09_jmatpro.ConstWriteMaterialStatistics = "WriteMaterialStatistics"

Command name for writing material calculation statistics.

const string IG.Script.S_12_09_jmatpro.ConstHelpWriteMaterialStatistics
Initial value:
=
@"Writes statistics about calculation of material properties.
First argument is the path to the settings file used.
Second argument (optional, boolean, default true) is a flag indicating whether
individual directories should also be reported.
Third argument (optional, boolean, default false) is a flag indicating whether
corrupted directories should be reported (takes considerably longer)."
const string IG.Script.S_12_09_jmatpro.ConstWriteMaterialsCalculated = "WriteCalculated"

Command name for writing information about successfully calculated materials.

const string IG.Script.S_12_09_jmatpro.ConstHelpWriteMaterialsCalculated
Initial value:
=
@"Writes information about successfully calculater material properties.
Sizes of material result files are written, with remarks on insufficient sizes.
First argument is the path to the settings file used."
const string IG.Script.S_12_09_jmatpro.ConstReleaseAbandonedMutex = "ReleaseMutex"

Command name for releasing abandoned mutex.

const string IG.Script.S_12_09_jmatpro.ConstHelpReleaseAbandonedMutex
Initial value:
=
@"Releases the file access locking mutex used by the JMAtPro interface' file manager.
Returns true if the mutex ha been abandoned and has thus actually been released.
First argument is the path to the settings file used."
const string IG.Script.S_12_09_jmatpro.ConstClearBusyFlags = "ClearBusyFlags"

Command name for clearing the busy flags for materials whose directories exist in the data root directory.

const string IG.Script.S_12_09_jmatpro.ConstHelpClearBusyFlags
Initial value:
=
@"This command is OBSOLETE! use """ + ConstMoveMaterialDirectoriesBusyFlagSet + @""" instead!
Clears the busy flags from all or from specified material calculation directories.
Returns the number of material calculation directories where flag has been calculated.
First argument is the path to the settings file used.
Following arguments (optional) are paths to material directories where busy flag should be cleared.
Paths can be specified relative to material data root (only directory names), relative to the
working directory or absolute.
If not specified then the flag is cleared in all material directories within the material
data root directory."
const string IG.Script.S_12_09_jmatpro.ConstRetryCalculateMaterialProperties = "RetryCalculateMaterial"

Command name for retrying calculation of material properties.

const string IG.Script.S_12_09_jmatpro.ConstHelpRetryCalculateMaterialProperties
Initial value:
=
@"Retries calculation of material properties.
Returns the number of material calculation directories where calculation has been retried.
First argument is the paths to the settings file used.
Following arguments (optional) are path to material directories for which calculation is retried.
Paths can be specified relative to material data root (only directory names), relative to the
working directory or absolute.
If not specified then recalculation is performed in all material directories within the material
data root directory where calculation was not successfully completed."
const string IG.Script.S_12_09_jmatpro.ConstMoveMaterialDirectoriesMaterialCalculated = "MoveCalculated"

Command name for moving to the appropriate storage the directories where material properties were successfully calculated.

const string IG.Script.S_12_09_jmatpro.ConstHelpMoveMaterialDirectoriesMaterialCalculated
Initial value:
=
@"Moves to the appropriate storage directory those material directories where
material properties were successfully calculated.
The first argument (optional) is the path to the settings file used."
const string IG.Script.S_12_09_jmatpro.ConstMoveMaterialDirectoriesBusyFlagSet = "MoveBusy"

Command name for moving to the appropriate storage the directories where busy flag remained set.

const string IG.Script.S_12_09_jmatpro.ConstHelpMoveMaterialDirectoriesBusyFlagSet
Initial value:
=
@"Moves to the appropriate storage directory those material directories where
busy flag remained set.
The first argument (optional) is the path to the settings file used."
const string IG.Script.S_12_09_jmatpro.ConstMoveMaterialDirectoriesTimedout = "MoveTimedout"

Command name for moving to the appropriate storage the directories where material properties calculation has timed out.

const string IG.Script.S_12_09_jmatpro.ConstHelpMoveMaterialDirectoriesTimedout
Initial value:
=
@"Moves to the appropriate storage directory those material directories where
calculation of material properties timed out.
The first argument (optional) is the path to the settings file used."
const string IG.Script.S_12_09_jmatpro.ConstMoveMaterialDirectoriesCalculationFailed = "MoveFailed"

Command name for moving to the appropriate storage the directories where calculation of material properties failed.

const string IG.Script.S_12_09_jmatpro.ConstHelpMoveMaterialDirectoriesCalculationFailed
Initial value:
=
@"Moves to the appropriate storage directory those material directories where
calculation of material properties has failed.
The first argument (optional) is the path to the settings file used."
const string IG.Script.S_12_09_jmatpro.ConstMoveMaterialDirectoriesDataCorrupted = "MoveCorrupted"

Command name for moving to the appropriate storage the directories where material data is corrupted (e.g. material parameters are not properly written).

const string IG.Script.S_12_09_jmatpro.ConstHelpMoveMaterialDirectoriesDataCorrupted
Initial value:
=
@"Moves to the appropriate storage directory those material directories where
material data is corrupted (e.g. material parameters are not properly written).
The first argument (optional) is the path to the settings file used."
const string IG.Script.S_12_09_jmatpro.ConstMoveMaterialDirectoriesAll = "MoveAll"

Command name for moving to the appropriate storage directories all the material directories that belong to the specific JMatPro file manager.

const string IG.Script.S_12_09_jmatpro.ConstHelpMoveMaterialDirectoriesAll
Initial value:
=
@"Moves to the appropriate storage directories all material directories. Each material
directory is moved to the appropriate storage directory according to its state.
The first argument (optional) is the path to the settings file used.
The second argumen (optional, default false) specifies whether directories where
busy flag is set are also moved.
The third argument (optional, default is false) specifies whether directories where
material properties have been successfully calculated are also moved."
const string IG.Script.S_12_09_jmatpro.ConstSaveSettings = "SaveSettings"

Command name for moving to the appropriate storage the directories where busy flag remained set.

const string IG.Script.S_12_09_jmatpro.ConstHelpSaveSettings
Initial value:
=
@"Saves the JMatPro file manager settings in order to check if they were read correctly.
The first argument is the path to the settings file used by the file manager.
The second argument (optional) is the name of the file where settings are saved,
within the working directory. If not specified then 00testsettings.json is used."
const string IG.Script.S_12_09_jmatpro.ConstTestRestart = "TestRestart"

Command name for moving to the appropriate storage the directories where busy flag remained set.

const string IG.Script.S_12_09_jmatpro.ConstHelpTestRestart
Initial value:
=
@"Test working of restart procedures, including uniqueness of parameter vector to material
directory name mapping.
The first argument (optional) is the path to the settings file used.
The second argument (optional) can be the name of the test material directory."
const string IG.Script.S_12_09_jmatpro.ConstTestMaterialResults = "TestMaterialResults"

Command name for moving to the appropriate storage the directories where busy flag remained set.

const string IG.Script.S_12_09_jmatpro.ConstHelpTestMaterialResults
Initial value:
=
@"Tests material results in the specified material directories (or in all successful & failed directories).
The first argument (optional) is the path to the settings file used.
The following arguments (optional) specify material directories from which results are tested."

Property Documentation

override string IG.Script.S_12_09_jmatpro.WorkingDirectory
getset

Working directory for this and derived scripts is teh same as optimization directory.

SimJMatProFileManagerBase IG.Script.S_12_09_jmatpro.JMatFM
getset

JMatPro file manager that is currently in use.

Setting this as class property enables implementation of some functions that are common for all commands using a JMAtPro file manager, such as finalization of the current file manager when the property is set to another object.


The documentation for this class was generated from the following file: