Modal
Solve parametric or time-dependent problem using the eigenmodal method.
Syntax
model.sol(sname).create(fname,"Modal")
model.sol(sname).feature(fname).set(pname,pvalue)
Description
Operation feature. The following properties are accepted:
Table 6-49: Valid Modal Properties for the Modal Solver.
Property
Value
Default
Description
analysistype
frequency | transient
frequency
Solve for frequency response or transient response.
atolglobal
positive scalar
0.001
Absolute tolerance when atolglobalvaluemethod is set to manual.
atolglobalfactor
positive scalar
0.1
Tolerance factor when atolglobalvaluemethod is set to factor.
atolglobalmethod
scaled | unscaled
scaled
Global method for the absolute tolerance when analysistype has been set to transient.
atolglobalvaluemethod
factor | manual
factor
Tolerance method if analysistype has been set to transient.
clist
String array
 
Provide values for constants as input parameters using a string array; for the corresponding constant names, use cname. See The clist and cname Properties.
cname
String array
 
Provide names of constants as input parameters using a string array; for the corresponding constant values, use clist. See The clist and cname Properties.
complex
true | false
false
Allow complex-valued data, if analysistype has been set to transient.
constrmodes
array of integers
 
The constraint modes to use, if constrmodeselection is set to manual.
constrmodeselection
all | manual
all
The constraint modes to use.
constrsol
solution object or none
 
The solution to use for the constraint modes.
control
String
user
Name of the controlling study step or user if the feature is controlled manually.
dampratio
scalar | numeric vector
0
Damping ratios for participating modes.
eigsol
solution object or none
 
Precomputed eigenpairs (or other vectors) to be used in the modal analysis.
eigsoluse
current | manual | an applicable solution
current
The parametric solution to use if such a solution has been set as the eigsol.
eigsolusesolnum
solution index
 
The solution index to use if eigsoluse is set to manual.
ewtrescale
true | false
true
Update scaled absolute tolerance when analysistype has been set to transient.
initialdataextend
automatic | true | false
automatic
Extend basis with initial data when analysistype has been set to transient.
keeplog
on | off
off
Keep warnings in stored log.
maxstepbdf
positive scalar
1e-1
Maximum time step when maxstepconstraintbdf is set to const.
maxstepconstraintbdf
auto | const | expr
auto
Maximum time step for time-dependent modal analysis: automatic (auto), constant (const), or an expression (expr).
maxstepexpressionbdf
String
 
Expression for the maximum time step when maxstepconstraintbdf is set to expr.
message
String
 
The log message from the last solution process.
modes
integer vector
all
Participating modes.
modeselection
all | manual
all
The eigenpairs to use.
outsollinearized
du | u
du
Store the total solution (u) or deviation and linearization point (du), when analysistype=frequency and storelinpoint=off.
plist
scalar | numeric vector
 
Frequency list. Only applicable when analysistype has been set to frequency.
pname
vector of strings
 
Parameter names.
pout
plist | fraction | spread
plist
Use plist as it stands or modify in relation to the participating modes.
romdata
String
new
Tag of the target container for the reduced model (new for a new reduced model).
romReconstruct
true | false
true
Enable reconstruction in the produced reduced model.
rtol
scalar
0.01
Relative tolerance. Only applicable when analysistype has been set to transient.
soltypemat
on | off
off
Store reduced-model matrices.
soltypeonline
on | off
off
Create a reduced model.
soltypesol
on | off
on
Perform frequency sweep or transient simulation using the modal solver.
storelinpoint
on | off
off
Whether to store the linearization point.
tderglobalfactor
positive scalar
1
Time derivative factor when tderglobalmethod is set to manual.
tderglobalmethod
auto | manual
auto
Derivative tolerance method when analysistype has been set to transient.
tlist
scalar | numeric vector
 
Time list. Only applicable when analysistype has been set to transient.
tunit
A valid time unit
s
Time unit. Only applicable when analysistype has been set to transient.
In addition, the following properties are available for exporting matrices and vectors:
Table 6-50: Valid Modal Properties for Matrix and Vector Export from the Modal Solver.
Property
Value
Default
Description
AllL
on | off
off
All load vectors, frequency.
B0r
on | off
off
Reduced initial value input matrix, transient.
B0rdot
on | off
off
Reduced initial time derivative input matrix, transient.
Br
on | off
off
Reduced input matrix, transient and frequency.
Brdot
on | off
off
Reduced time derivative input matrix, transient.
Brdotdot
on | off
off
Reduced second time derivative input matrix, transient.
C
on | off
off
Output matrix (state space).
Clmap
on | off
off
Constraint modes to inputs map.
Cr
on | off
off
Reduced output matrix, transient and frequency.
D
on | off
off
Input feedback matrix (state space).
DPartSol
on | off
off
Damping matrix times particular solution, frequency.
Dr
on | off
off
Reduced damping matrix, transient and frequency.
Dra
on | off
off
Damping ratio matrix, transient and frequency.
EPartSol
on | off
off
Mass matrix times particular solution, frequency.
Er
on | off
off
Reduced mass matrix, transient and frequency.
F
on | off
off
Input feedback, transient and frequency.
Kr
on | off
off
Reduced stiffness matrix, transient and frequency.
Kud
on | off
off
Stiffness matrix times ud, transient.
L
on | off
off
Load vector, transient and frequency.
MA
on | off
off
Stiffness matrix (state space).
MB
on | off
off
Input matrix (state space).
Mc
on | off
off
Mass matrix (state space).
Null
on | off
off
Projection matrix (state space).
Pm
on | off
off
Projection matrix, transient and frequency.
U0
on | off
off
Initial value vector, transient.
ud
on | off
off
Particular solution (state space).
Udot0
on | off
off
Initial derivative vector, transient.
x0
on | off
off
Initial value (state space).
Y0
on | off
off
Output bias, transient and frequency.
The reduced matrices are the matrices that result from the elimination of constraints in the discretized model.
For frequency response analysis, nonconstant Neumann boundary conditions and constant Dirichlet boundary conditions are supported. The only allowed type of parameter-dependent Dirichlet boundary condition are those that can be written as a constant vector times a scalar function. The scalar function is specified via the property loadfact. For transient response analysis only constant Dirichlet boundary conditions are supported. Neumann conditions that can be written as a constant vector times a scalar function are supported for transient response (specified in a Frequency Domain, Modal or Time Dependent, Modal study step).
The property modes is index 0 based.
If pout is set to fraction the output frequencies are the ones in plist multiplied by the absolute value of the largest eigenvalue in eigsol (or some other fraction of the largest participating eigenvalue of eigsol). The purpose of this property is to be able to automatically compute the frequency response for reasonable frequencies. If pout is set to spread then plist is interpreted as an interval around each participating eigenvalue. For example, if plist is set to range(0.9,0.04,1.1) then each participating eigenvalue is multiplied by this list, and the resulting lists are concatenated into the plist that is used.
Removed Properties
Table 6-51: Removed Properties for the Modal Solver Sequence Feature.
Property
Reason
Callblevel
Given by the solver sequence attribute feature.
soltype
Deprecated in version 5.3 and replaced with soltypesol, soltypemat, and soltypeonline.