KerMor  0.9
Model order reduction for nonlinear dynamical systems and nonlinear approximation
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
JaRMoSExport Class Referenceabstract

JaRMoSExport: Export base class for JaRMoS Models. More...

Detailed Description

JaRMoSExport: Export base class for JaRMoS Models.

Author
Daniel Wirtz
Date
2011-08-02
Change in 0.7:
(Daniel Wirtz, 2013-08-11) Moved the +export package from KerMor to an own git repository (and re-included it in KerMor in extern/matlabtojarmos)
Change in 0.6:
(Daniel Wirtz, 2012-03-24) Restructured the export functions and classes. This class was the former AppExport class.
Change in 0.5:
(Daniel Wirtz, 2011-10-06) Moved this class to the export package.
Change in 0.5:
(Daniel Wirtz, 2011-08-25) The saveRealMatrix and saveRealVector now save the matrix in the given class, i.e. double,single (=float32, 4bytes), int32 etc.
New in 0.5:
(Daniel Wirtz, 2011-08-02) Added this class.

This class is part of the framework

KerMor - Model Order Reduction using Kernels

Definition at line 17 of file JaRMoSExport.m.

Public Member Functions

function  exportModel (models.ReducedModel model,char folder)
 Exports the given model for use in JaRMoS to the given folder. More...
 

Public Attributes

integer DoFFields = 0
 The number of degrees of freedom-fields this system computes as output. More...
 
struct LogicalFields = "[]"
 Returns the field descriptions for each logical solution field. More...
 
function_handle GeometryExportCallback = "[]"
 A callback for geometry export of the JaRMoS-Model. More...
 
char JavaExportPackage = ""
 The package of any java classes associated with this model when exported to JaRMoS. More...
 
char JaRMoSBaseSource = ""
 The JaRMoSBase java sources directory. Required if any java classes are to by compiled. More...
 
char ModelType = "Unknown"
 The model type according to the jarmos.ModelType enum. More...
 
char Short = ""
 Short description for the model. 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...
 

Protected Member Functions

virtual function [

sourcebase ,
sourcefiles ] = 
typeSpecificExport (f,models.BaseFullModel model, settings, folder)
 

Member Function Documentation

function JaRMoSExport.exportModel ( models.ReducedModel  model,
char  folder 
)

Exports the given model for use in JaRMoS to the given folder.

Parameters
modelThe model to export.
folderThe target folder

Definition at line 136 of file JaRMoSExport.m.

References KerMor.App(), DoFFields, GeometryExportCallback, JaRMoSBaseSource, JavaExportPackage, LogicalFields, ModelType, Short, and typeSpecificExport().

Here is the call graph for this function:

virtual function [sourcebase , sourcefiles ] = JaRMoSExport.typeSpecificExport (   f,
models.BaseFullModel  model,
  settings,
  folder 
)
protectedpure virtual

Referenced by exportModel().

Here is the caller graph for this function:

Member Data Documentation

JaRMoSExport.DoFFields = 0

The number of degrees of freedom-fields this system computes as output.

Real valued and complex valued fields count as one DoF-field.

Default: 0

Definition at line 50 of file JaRMoSExport.m.

Referenced by exportModel().

JaRMoSExport.GeometryExportCallback = "[]"

A callback for geometry export of the JaRMoS-Model.

The function takes two arguments
f: A file handle of the model.xml file ready for writing with fprintf folder: The target folder for binaries

Default: []

Definition at line 78 of file JaRMoSExport.m.

Referenced by exportModel().

JaRMoSExport.JaRMoSBaseSource = ""

The JaRMoSBase java sources directory. Required if any java classes are to by compiled.

Default: '

Definition at line 103 of file JaRMoSExport.m.

Referenced by exportModel().

JaRMoSExport.JavaExportPackage = ""

The package of any java classes associated with this model when exported to JaRMoS.

Default: '

Definition at line 92 of file JaRMoSExport.m.

Referenced by exportModel().

JaRMoSExport.LogicalFields = "[]"

Returns the field descriptions for each logical solution field.

Is a struct for each field with the struct-fields

  • Type: The string representation of the jarmos.SolutionFieldType enum
  • Name: The name of the solution field (optional)
  • Mapping: One of the jarmos.geometry.FieldMapping enum string values. (optional, default VERTEX)

    Default: []

Definition at line 62 of file JaRMoSExport.m.

Referenced by exportModel().

JaRMoSExport.ModelType = "Unknown"

The model type according to the jarmos.ModelType enum.

Default: Unknown

Definition at line 114 of file JaRMoSExport.m.

Referenced by exportModel(), and JKerMorExport.JKerMorExport().

JaRMoSExport.Short = ""

Short description for the model.

Default: '

Definition at line 124 of file JaRMoSExport.m.

Referenced by exportModel().


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