model.reduced()

There are reduced-order models of different types. The properties listed below are set and accessed using generic set and get methods described in set() and get* and Selection Access Methods. The following reduced-order model types are currently supported:

Table 2-102: Reduced-order Model Types
Type	Description
ModalFrequency	Created by the Model Reduction study step for a parametric problem using the modal solver.
ModalTransient	Created by the Model Reduction study for a time-dependent problem using the modal solver.
AWE	Created by the Model Reduction study step for a parametric problem using the asymptotic waveform evaluation (AWE) solver.
RandomVibration	Uses a Frequency-Domain, Modal Reduced-Order Model to compute model response to random excitations.

Syntax

model.reduced()

model.reduced().create(<tag>, <type>);

model.reduced().getM(String)

model.reduced().getN(String)

model.reduced().getNnz(String)

model.reduced().getOutputs()

model.reduced().getParameters()

model.reduced().getSparseMatrixCol(String)

model.reduced().getSparseMatrixRow(String)

model.reduced().getSparseMatrixVal(String)

model.reduced().getSparseMatrixValImag(String)

model.reduced().getVector(String)

model.reduced().getVectorImag(String)

model.reduced().isReal(String)

description

model.reduced().create(<tag>, <type>) creates a reduced-model container of the specified type.

Depending on the type of reduced-order model, the following properties are available:

Table 2-103: Properties For All Reduced-Order model Types
NAME	VALUE	DEFAULT	DESCRIPTION	Read Only
depvars	boolean	false	Controls if models with output variables should define degrees of freedom.
depvarnames	String array	{}	Names of dependent variables.
information	String	""	Model information.	√
logMessage	String	""	The Build log.	√
matrices	String matrix	{{}}	Names and descriptions of matrices.	√
metaCOMSOLversion	String	""	String description of the COMSOL version when the model has been created.	√
metaCOMSOLversionInt	String	""	Numerical representation of the COMSOL version when the model has been created.	√
outputDescr	String array	{}	Descriptions of output variables.	√
outputExpr	String array	{}	Values or expressions of output variables.	√
outputNames	String array	{}	Names of output variables.	√
reconstructors	String array	{}	Names of reconstruction variables.	√
reconstructorDescr	String array	{}	Descriptions of reconstruction variables.	√
vectors	String matrix	{{}}	Names and descriptions of vectors.	√

Table 2-104: Properties For the ModalFrequency Reduced-Order model
NAME	VALUE	DEFAULT	DESCRIPTION	Read Only
controls	String array	{}	Values or expressions of control variables.
controlDescr	String array	{}	Descriptions of control variables.	√
controlNames	String array	{}	Names of control variables.	√
loadfact	String	"1"	Load factor value or expression.
matrices	String matrix	{{"Kr", "Stiffness matrix"}, {"Dr", "Damping matrix"}, {"Dra", "Damping ratio matrix"}, {"Er", "Mass matrix"}, {"Br", "Input matrix"}, {"Cr", "Output matrix"}, {"F", "Input feedback matrix"}}	Names and descriptions of matrices.	√
parameters	String array	{"freq"}	Values or expressions of parameters.
parameterNames	String array	{"Frequency"}	Names of parameters.	√
vectors	String matrix	{{"L", "Load vector"}, {"Y0", "Output bias"}, {"EPartSol", "Mass matrix times particular solution"}, {"DPartSol", "Damping matrix times particular solution"}}	Names and descriptions of vectors.	√

Table 2-105: Properties For the ModalTransient Reduced-Order model
NAME	VALUE	DEFAULT	DESCRIPTION	Read Only
controls	String array	{}	Values or expressions of control variables.
controlDescr	String array	{}	Descriptions of control variables.	√
controlNames	String array	{}	Names of control variables.	√
loadfact	String	"1"	Load factor value or expression.
matrices	String matrix	{{"Kr","Stiffness matrix"}, {"Kr", "Stiffness matrix"}, {"Dr", "Damping matrix"}, {"Dra", "Damping ratio matrix"}, {"Er", "Mass matrix"}, {"Br", "Input matrix"}, {"Cr", "Output matrix"}, {"F", "Input feedback matrix"}, {"B0r","Initial value input matrix"}, {"B0rdot", "Initial value time derivative input matrix"}, {"Brdot", "Time derivative input matrix"}, {"Brdotdot", "Second time derivative input matrix"}, {"Mc", "Damping matrix"}, {"MA", "Stiffness matrix"}, {"MB", "Input matrix"}, {"D", "Input feedback matrix"}, {"C", "Output matrix"}}	Names and descriptions of matrices.	√
parameters	String array	{"freq"}	Values or expressions of parameters.
parameterNames	String array	{"Frequency"}	Names of parameters.	√
rtol	double	0.01	Relative tolerance.
vectors	String matrix	{{"L","Load vector"}, {"Y0", "Output bias"}, {"U0","Output bias"}, {"Udot0","Initial derivative vector"}, {"Kud","Stiffness matrix times ud"}, {"x0","Initial value vector"}}	Names and descriptions of vectors.	√

Table 2-106: Properties For the AWE Reduced-Order model
NAME	VALUE	DEFAULT	DESCRIPTION	Read Only
parameters	String array	{"freq"}	Values or expressions of parameters.
parameterNames	String array	{"Frequency"}	Names of parameters.	√

Table 2-107: Properties for the Random Vibration Model
NAME	VALUE	DEFAULT	DESCRIPTION
correlationMatrix	upper-triangle of a matrix	all 0s	The correlation matrix, when correlationType is crossCorrelated.
correlationType	uncorrelated \| fullyCorrelated \| crossCorrelated	uncorrelated	The correlation type.
frequencyResponseModel	name of frequency-domain, modal reduced-order model		The frequency response model to use. Specify its components using the setIndex method.
powerSpectralDensity	double scalar vector	all 0s	The power spectral density for each control name. Specify each power spectral density using the setIndex method.

For information about the getM, getN, getNnz, isReal, and the getSparseMatrix and getVector methods, see the matrix data tables Table 6-6 and Table 6-7 in the Solvers and Study Steps chapter.

Compatibility

The following methods are deprecated in version 5.5 and may be removed in future versions:

getDescription(String[])

getString(String)

setControl(String, String)

The following methods are not supported:

create(<tag>)

create(<tag>, filepath)

setParameter(String, String)

renameControl(String, String)

renameOutput(String, String)