KerMor
0.9
Model order reduction for nonlinear dynamical systems and nonlinear approximation
|
Global configuration class for all KerMor run-time settings. More...
Global configuration class for all KerMor run-time settings.
Software documentation can be found at http://www.morepas.org/software/kermor/index.html
Any KerMor developers should check out the pages KerMor Development for coding guidelines and conventions.
solvers.ode
to solvers
+general
dbstop if error
in the KerMor start script. No more lost data! :-)rbmatlabDirectory
with KerMor. Without having setup this directory any models.rbmatlab classes will not work correctly.Static Public Member Functions | |
static function KerMor theinstance = | App () |
The singleton KerMor instance. More... | |
static function | setup () |
Performs installation of KerMor on a system. More... | |
static function KerMor app = | start () |
Starts the KerMor application. More... | |
static function | stop () |
Ends the KerMor application. More... | |
static function host = | getHost () |
Returns the hostname of the current machine. More... | |
static function b = | getGitBranch (dir) |
Returns the current git commit in a descriptive string. More... | |
static function char d = | DocumentationLocation () |
Returns the location of the kermor documentation. More... | |
static function | createLogo () |
Creates the KerMor logo. More... | |
static function tag = | getPrefTag () |
Returns the tag used to store the KerMor preferences and settings. More... | |
static function d = | getDir () |
Returns a folder selected by a uigetdir command. Remembers the last selected folder (if successful & existing) More... | |
Public Attributes | |
char | DataDirectory |
The directory to use for simulation data storage. More... | |
logical | UseDPCM |
Switch to determine if the Default Property Changed System shall be used or not. More... | |
double | BlockSize |
The default block size (in MB) for FileMatrix instances. More... | |
char | DesktopLayout = "" |
The preferred desktop layout to work with. More... | |
char | rbmatlabDirectory = "" |
The source directory for a copy of rbmatlab. More... | |
char | JKerMorSourceDirectory = "" |
The source directory for JKerMor, if available. More... | |
integer | Verbose = "[]" |
Verbose output level. More... | |
rowvec | DefaultFigurePosition = "[]" |
The default figure position to use. More... | |
logical | UseDiary = "[]" |
Flag that determines if KerMor also enables the diary function upon startup. More... | |
char | Workspace |
The base directory where KerMor stores and looks for data from models etc. More... | |
HomeDirectory | |
The KerMor home directory. More... | |
Hasrbmatlab = false | |
Flag if rbmatlab wrapping functionalities are enabled. More... | |
char | TempDirectory = "" |
The directory to use for temporary simulation data. More... | |
Public Attributes inherited from handle | |
addlistener | |
Creates a listener for the specified event and assigns a callback function to execute when the event occurs. More... | |
notify | |
Broadcast a notice that a specific event is occurring on a specified handle object or array of handle objects. More... | |
delete | |
Handle object destructor method that is called when the object's lifecycle ends. More... | |
disp | |
Handle object disp method which is called by the display method. See the MATLAB disp function. More... | |
display | |
Handle object display method called when MATLAB software interprets an expression returning a handle object that is not terminated by a semicolon. See the MATLAB display function. More... | |
findobj | |
Finds objects matching the specified conditions from the input array of handle objects. More... | |
findprop | |
Returns a meta.property objects associated with the specified property name. More... | |
fields | |
Returns a cell array of string containing the names of public properties. More... | |
fieldnames | |
Returns a cell array of string containing the names of public properties. See the MATLAB fieldnames function. More... | |
isvalid | |
Returns a logical array in which elements are true if the corresponding elements in the input array are valid handles. This method is Sealed so you cannot override it in a handle subclass. More... | |
eq | |
Relational functions example. See details for more information. More... | |
transpose | |
Transposes the elements of the handle object array. More... | |
permute | |
Rearranges the dimensions of the handle object array. See the MATLAB permute function. More... | |
reshape | |
hanges the dimensions of the handle object array to the specified dimensions. See the MATLAB reshape function. More... | |
sort | |
ort the handle objects in any array in ascending or descending order. More... | |
Static Public Attributes | |
static const ::char | MainVersion = "0" |
The current KerMor main version number. More... | |
static const ::char | SubVersion = "7" |
The current KerMor sub version number. More... | |
static const ::char | PrefTagPrefix = "KerMor_at_" |
The prefix for the host-dependent preference tags. More... | |
|
static |
The singleton KerMor instance.
Access to the main programs instance via KerMor.App!
theinstance | The singleton instance |
Definition at line 910 of file KerMor.m.
Referenced by dscomponents.AffLinCoreFun.addMatrix(), testing.Speed.BinaryvsMatSave(), approx.algorithms.AAdaptiveBase.checkStop(), data.ApproxTrainData.computeFrom(), general.POD.computePOD(), models.rbmatlab.RBMatlabModel.computeTrajectory(), models.BaseFullModel.computeTrajectory(), models.ReducedModel.createImage(), models.mathmod2012.MathMODExperiment.CreatePlots(), models.wh10.WH10Experiment.Experiment1(), JaRMoSExport.exportModel(), data.FileDataCollection.FileDataCollection(), data.FileMatrix.FileMatrix(), data.FileTrajectoryData.FileTrajectoryData(), spacereduction.PODGreedy.generateReducedSpaceImpl(), spacereduction.BaseSpaceReducer.getInitialSpace(), general.DEIM.getInterpolationPoints(), models.burgers.Tests.getMoRePasDir(), data.ABlockedData.getSVD(), BinTree.Insert(), Utils.logNorm(), data.ApproxTrainData.makeUniqueXi(), models.muscle.Model.Model(), data.ModelData.ModelData(), models.BaseFullModel.off2_genTrainingData(), models.BaseFullModel.off5_computeApproximation(), models.BaseFullModel.off6_prepareErrorEstimator(), error.DEIMEstimator.offlineComputations(), error.lipfun.ImprovedLocalSecantLipschitz.precompMaxSecants(), models.rbmatlab.RBMatlabModel.RBMatlabModel(), DPCMObject.registerProps(), data.ModelData.relocate(), MUnit.RunClassTests(), kernels.GaussKernel.setGammaForDistance(), models.rbmatlab.RBMatlabModel.simulate(), general.regression.BaseQPSVR.solve(), approx.algorithms.VKOGA.startAdaptiveExtension(), approx.algorithms.Componentwise.templateComputeApproximation(), data.FileDataCollection.test_FileDataCollection(), dscomponents.ACoreFun.test_Jacobian(), models.pcd.Tests.tests_PCD_DEIM_1D(), models.pcd.Tests.tests_PCD_DEIM_2D(), models.pcd.Tests.tests_PCD_DEIM_2D_500s(), and general.DEIM.updateOrderData().
|
static |
|
static |
|
static |
Returns a folder selected by a uigetdir command. Remembers the last selected folder (if successful & existing)
Definition at line 1114 of file KerMor.m.
References t.
Referenced by data.FileMatrix.recoverFrom().
|
static |
Returns the current git commit in a descriptive string.
Definition at line 1039 of file KerMor.m.
Referenced by models.BaseModel.saveobj(), models.pcd.Tests.tests_PCD_DEIM_1D(), models.pcd.Tests.tests_PCD_DEIM_2D(), and models.pcd.Tests.tests_PCD_DEIM_2D_500s().
|
static |
Returns the hostname of the current machine.
Definition at line 1023 of file KerMor.m.
Referenced by data.FileData.FileData(), data.FileData.getfile(), data.FileData.loadobj(), and data.FileData.relocate().
|
static |
Returns the tag used to store the KerMor preferences and settings.
Note that the tag is machine/host-dependent. The initialization routine checks for the existence, and if none is found possible configurations from other hosts are suggested if found.
tag | The host-dependent tag used for KerMor preferences |
Definition at line 1098 of file KerMor.m.
Referenced by Utils.saveFigure().
|
static |
Performs installation of KerMor on a system.
Adds variables to the users environment, so far only needed for the documentation creation. Custom paths for data storage are checked and set by the start script.
If no rbmatlab directory is already presently set by a previous install, the installation program asks if an rbmatlab-installation should be registered with KerMor.
Definition at line 928 of file KerMor.m.
References handle.disp, and Devel.setup().
|
static |
Starts the KerMor application.
This static method initializes the environment and performs initial availability checks for e.g. 3rd party programs and matlab toolboxes.
Additionally, some path variables are tried to be read from environment variables if set. If no settings are made yet the user is prompted to select them!
app | The KerMor instance |
|
static |
KerMor.BlockSize |
The default block size (in MB) for FileMatrix instances.
File matrices are used to store matrices that would otherwise not fit into memory entirely. Hence, they are subdivided into blocks, which are stored in the file system.
This is a machine-dependent property and should be used according to the local total memory availability.
Default: data.FileMatrix.BLOCK_SIZE
Dependent
set to true. KerMor.DataDirectory |
The directory to use for simulation data storage.
In this folder large simulation and model data will be stored and read by KerMor. Can be set anytime during runtime. If no value is given the KerMor.start script will ask for it.
Default: ./data
Dependent
set to true. KerMor.DefaultFigurePosition = "[]" |
The default figure position to use.
If none is set, KerMor does not modify the root workspace property DefaultFigurePosition
upon startup.
Default: []
Dependent
set to true. KerMor.DesktopLayout = "" |
The preferred desktop layout to work with.
If you work with different desktop layouts or the KDE JUST DOES NOT GET IT you can save your custom desktop layout and set this property to its name. Upon start, KerMor will restore the layout for you automatically. Set to ' to disable.
Default: '
Dependent
set to true. KerMor.Hasrbmatlab = false |
Flag if rbmatlab wrapping functionalities are enabled.
Indicates if rbmatlab is available and initialized.
Default: false
Dependent
set to true. SetAccess = Private, GetAccess = Public
This function checks for a set rbmatlabDirectory and if the rbmatlab script rbmatlabhome
is within the current path (=substitute for the rbmatlab startup-script being executed)
KerMor.HomeDirectory |
The KerMor home directory.
SetAccess = Private, GetAccess = Public
KerMor.JKerMorSourceDirectory = "" |
The source directory for JKerMor, if available.
Sets the JKerMor source directory.
Default: '
Dependent
set to true. Throws an exception if the path is invalid or does not contain a selected JKerMor class.
|
static |
The current KerMor main version number.
Change only AFTER committing the final last version's state. Used in Devel to fill the new class templates etc.
Default: "0"
|
static |
KerMor.rbmatlabDirectory = "" |
The source directory for a copy of rbmatlab.
Sets the rbmatlab source directory.
Default: []
Dependent
set to true. Throws an exception if the path is invalid or does not contain the rbmatlab startup script.
|
static |
The current KerMor sub version number.
Change only AFTER committing the final last version's state. Used in Devel to fill the new class templates etc.
Default: "7"
KerMor.TempDirectory = "" |
The directory to use for temporary simulation data.
Returns the directory for temporary files.
It is located in a "tmp" subfolder of the DataDirectory path. Default: DataDirectory/tmp
Dependent
set to true. SetAccess = Private, GetAccess = Public
It is located in a "tmp" subfolder of the DataDirectory path.
KerMor.UseDiary = "[]" |
Flag that determines if KerMor also enables the diary
function upon startup.
For each day, a diary named [Date]_KerMor[Version]Log.txt
is created inside the KerMor.TempDirectory.
Default: true
Dependent
set to true. KerMor.UseDPCM |
Switch to determine if the Default Property Changed System shall be used or not.
Default: false
Dependent
set to true. KerMor.Verbose = "[]" |
Verbose output level.
Default: 1
Dependent
set to true. KerMor.Workspace |
The base directory where KerMor stores and looks for data from models etc.
Default: KerMor.DataDirectory
Dependent
set to true.