com.comsol.model

Interface ReducedModel

All Superinterfaces:

ModelEntity, PrimitiveModelEntity, PropFeature, ReducedModelBase, SelectionContainer, SelectionEntity

public interface ReducedModel
extends ReducedModelBase

The top level object for reduced model.

Method Summary

Modifier and Type	Method and Description
java.lang.String[]	getControls() Controls of the model.
java.lang.String[]	getDescriptions(java.lang.String[] names) Descriptions of properties.
int	getM(java.lang.String mName) Returns number of rows in matrix.
java.lang.String[]	getMatrices() Reduced model matrices.
int	getN(java.lang.String mName) Returns number of columns in matrix.
int	getNnz(java.lang.String mName) Get number of non-zeros in sparse matrix.
java.lang.String[]	getOutputs() Outputs of the model.
java.lang.String[]	getParameters() Parameters of the model.
int[]	getSparseMatrixCol(java.lang.String mName) Returns column indices of matrix values.
int[]	getSparseMatrixRow(java.lang.String mName) Returns row indices of matrix values.
double[]	getSparseMatrixVal(java.lang.String mName) Returns matrix values.
double[]	getSparseMatrixValImag(java.lang.String mName) Returns imaginary matrix values.
java.lang.String	getString(java.lang.String name) Gets string property.
java.lang.String[]	getValues(java.lang.String[] names) Get values of the model.
double[]	getVector(java.lang.String mName) Returns the real vector associated with the matrix type.
double[]	getVectorImag(java.lang.String mName) Get the imaginary part of the vector associated with the matrix type.
java.lang.String[]	getVectors() Reduced model vectors.
boolean	isReal(java.lang.String mName) Check if matrix is is real.
void	renameControl(java.lang.String currentName, java.lang.String newName) Rename the controls of the model.
void	renameOutput(java.lang.String currentName, java.lang.String newName) Rename the outputs of the model.
ReducedModel	set(java.lang.String name, java.lang.String value) Sets string property value.
void	setControl(java.lang.String name, java.lang.String value) Set control values of the model.
void	setParameter(java.lang.String name, java.lang.String value) Set parameter values of the model.

Methods inherited from interface com.comsol.model.PropFeature

getAllowedPropertyValues, getBoolean, getBoolean, getBoolean, getBooleanArray, getBooleanMatrix, getDouble, getDouble, getDouble, getDoubleArray, getDoubleMatrix, getEntryKeyIndex, getEntryKeys, getInt, getInt, getInt, getIntArray, getIntMatrix, getReferenceArray, getString, getString, getString, getStringArray, getStringMatrix, getType, getValueType, hasProperty, hasSelection, move, move, properties, remove, remove, selection, set, set, set, set, set, set, set, set, set, set, set, setEntry, setEntry, setEntry, setEntry, setIndex, setIndex, setIndex, setIndex, setIndex, setIndex, setIndex, setIndex, setIndex, setIndex, setIndex, setIndex

Methods inherited from interface com.comsol.model.SelectionEntity

selection

Methods inherited from interface com.comsol.model.ModelEntity

active, author, author, comments, comments, dateCreated, dateModified, docMarker, docMarker, help, help, icon, isactive, isActive, label, label, lastModifiedBy, model, model, name, name, resetAuthor, scope, tag, tag, timeCreated, timeModified, version, version

Methods inherited from interface com.comsol.model.PrimitiveModelEntity

getContainer, getDisplayString

Method Detail

getControls

java.lang.String[] getControls()

Controls of the model.

Returns:

Control names.

getDescriptions

java.lang.String[] getDescriptions(java.lang.String[] names)

Descriptions of properties.

Parameters:

names - The names of the properties.

Returns:

Descriptions.

getM

int getM(java.lang.String mName)

Returns number of rows in matrix.

Parameters:

mName - Matrix name.

Returns:

Number of rows.

getMatrices

java.lang.String[] getMatrices()

Reduced model matrices.

Returns:

matrix names.

getN

int getN(java.lang.String mName)

Returns number of columns in matrix.

Parameters:

mName - Matrix name.

Returns:

Number of columns.

getNnz

int getNnz(java.lang.String mName)

Get number of non-zeros in sparse matrix.

Parameters:

mName - Matrix name.

Returns:

Number of non-zeros.

getOutputs

java.lang.String[] getOutputs()

Outputs of the model.

Returns:

Output names.

getParameters

java.lang.String[] getParameters()

Parameters of the model.

Returns:

Parameter names.

getSparseMatrixCol

int[] getSparseMatrixCol(java.lang.String mName)

Returns column indices of matrix values.

Parameters:

mName - Matrix name.

Returns:

Column indices.

getSparseMatrixRow

int[] getSparseMatrixRow(java.lang.String mName)

Returns row indices of matrix values.

Parameters:

mName - Matrix name.

Returns:

Row indices.

getSparseMatrixVal

double[] getSparseMatrixVal(java.lang.String mName)

Returns matrix values.

Parameters:

mName - Matrix name.

Returns:

Matrix values.

getSparseMatrixValImag

double[] getSparseMatrixValImag(java.lang.String mName)

Returns imaginary matrix values.

Parameters:

mName - Matrix name.

Returns:

Matrix values representing imaginary part.

getString

java.lang.String getString(java.lang.String name)

Gets string property.

Specified by:

getString in interface PropFeature

Parameters:

name - Property name.

Returns:

Property value.

getValues

java.lang.String[] getValues(java.lang.String[] names)

Get values of the model.

Parameters:

names - The names of the values.

Returns:

Value names.

getVector

double[] getVector(java.lang.String mName)

Returns the real vector associated with the matrix type.

Parameters:

mName - Matrix name.

Returns:

Vector representing real part.

getVectorImag

double[] getVectorImag(java.lang.String mName)

Get the imaginary part of the vector associated with the matrix type.

Parameters:

mName - Matrix name.

Returns:

Vector representing imaginary part.

getVectors

java.lang.String[] getVectors()

Reduced model vectors.

Returns:

vector names.

isReal

boolean isReal(java.lang.String mName)

Check if matrix is is real.

Parameters:

mName - Matrix name.

Returns:

true if matrix is real.

renameControl

void renameControl(java.lang.String currentName,
                   java.lang.String newName)

Rename the controls of the model.

Specified by:

renameControl in interface ReducedModelBase

Parameters:

currentName - The current name of the variable.

newName - The new name of the variable.

renameOutput

void renameOutput(java.lang.String currentName,
                  java.lang.String newName)

Rename the outputs of the model.

Parameters:

currentName - The current name of the variable.

newName - The new name of the variable.

set

ReducedModel set(java.lang.String name,
                 java.lang.String value)

Sets string property value.

Specified by:

set in interface PropFeature

Parameters:

name - Property name.

value - Property value.

Returns:

Property.

setControl

void setControl(java.lang.String name,
                java.lang.String value)

Set control values of the model.

Specified by:

setControl in interface ReducedModelBase

Parameters:

name - The name of the control.

value - The value of the control.

setParameter

void setParameter(java.lang.String name,
                  java.lang.String value)

Set parameter values of the model.

Parameters:

name - The name of the parameter.

value - The value of the parameter.