com.comsol.model

Interface ReducedModel

All Superinterfaces:

ModelEntity, PrimitiveModelEntity

public interface ReducedModel
extends ModelEntity

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.
java.lang.String[]	getInternals() Internal states of the model.
java.lang.String[]	getMatrices() Projection matrix from full to reduced.
java.lang.String[]	getMetadata() Metadata of the model.
java.lang.String	getMetadata(java.lang.String name) Metadata of the model.
java.lang.String[]	getOutputs() Outputs of the model.
java.lang.String[]	getParameters() Parameters of the model.
java.lang.String[]	getRange(java.lang.String name) Range for property.
java.lang.String[]	getStates() States of the model.
java.lang.String[]	getValues(java.lang.String[] names) Get values of the model.
java.lang.String[]	getVectors() Transformation matrix from reduced to full.
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.
void	setControl(java.lang.String name, java.lang.String value) Set control values of the model.
void	setOutput(java.lang.String name, java.lang.String value) Set output expressions describing where to write the outputs of the model.
void	setParameter(java.lang.String name, java.lang.String value) Set parameter values of the model.
void	setState(java.lang.String name, java.lang.String value) Set states of the model.

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.

getInternals

java.lang.String[] getInternals()

Internal states of the model.

Returns:

Internal state names.

getMatrices

java.lang.String[] getMatrices()

Projection matrix from full to reduced.

Returns:

matrix variable names.

getMetadata

java.lang.String[] getMetadata()

Metadata of the model.

Returns:

Metadata names.

getMetadata

java.lang.String getMetadata(java.lang.String name)

Metadata of the model.

Parameters:

name - The name of the metadata.

Returns:

Metadata.

getOutputs

java.lang.String[] getOutputs()

Outputs of the model.

Returns:

Output names.

getParameters

java.lang.String[] getParameters()

Parameters of the model.

Returns:

Parameter names.

getRange

java.lang.String[] getRange(java.lang.String name)

Range for property.

Parameters:

name - The name of the property.

Returns:

Range min, max.

getStates

java.lang.String[] getStates()

States of the model.

Returns:

State names.

getValues

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

Get values of the model.

Parameters:

names - The names of the values.

Returns:

Value names.

getVectors

java.lang.String[] getVectors()

Transformation matrix from reduced to full.

Returns:

matrix variable name.

renameControl

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

Rename the controls of the model.

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.

setControl

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

Set control values of the model.

Parameters:

name - The name of the control.

value - The value of the control.

setOutput

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

Set output expressions describing where to write the outputs of the model.

Parameters:

name - The name of the output.

value - The expression for where to write the value.

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.

setState

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

Set states of the model.

Parameters:

name - The state names.

value - The value of the state.