Package com.comsol.model
Interface MaterialModel
-
- All Superinterfaces:
EquationViewParent
,ModelEntity
,ParameterContainer
,ParameterEntity
,PrimitiveModelEntity
,SelectionContainer
,SelectionEntity
public interface MaterialModel extends ModelEntity, ParameterEntity, EquationViewParent
Material property group.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Deprecated Methods Modifier and Type Method Description MaterialModel
addinput(java.lang.String arg0)
Deprecated.UseaddInput(String)
instead.MaterialModel
addInput(java.lang.String quantity)
Adds a new model input to the material model of the given quantity.java.lang.String
descr(java.lang.String name)
Gets the description of the given property.MaterialModel
descr(java.lang.String name, java.lang.String descr)
Sets the description for the given property.FunctionFeatureList
func()
Returns list of function objects.FunctionFeature
func(java.lang.String tag)
Returns the function object with the given tag.java.lang.String
getMixingRule(java.lang.String name)
Returns the mixing rule for the given material property.java.lang.String
getPropertyInfo(java.lang.String name)
Returns the property info (references, temperature conditions, etc.) for the given material property.java.lang.String
getString(java.lang.String name)
Returns the string value of the given property.java.lang.String[]
getStringArray(java.lang.String name)
Returns the string array value of the given property.java.lang.String
getType()
Returns the type of the property group.java.lang.String
getValueType(java.lang.String name)
Returns the main data type that a property can return.boolean
hasParam(java.lang.String name)
Returns true if the property is defined by the material model.java.lang.String
identifier()
Returns the name of the property group.MaterialModel
identifier(java.lang.String name)
Sets the name of the property group to make it different from the tag.InformationList
info()
Returns the information objects for the material model.Information
info(java.lang.String tag)
Returns the information object for the material model.java.lang.String[]
input()
Returns the list of model inputs.MaterialModel
removeinput(java.lang.String arg0)
Deprecated.UseremoveInput(String)
instead.MaterialModel
removeInput(java.lang.String quantity)
Removes the given quantity from the list of model inputs.MaterialModel
removeOutput(java.lang.String quantity)
Removes the given output quantity from the list of outputs.MaterialModel
removeParam(java.lang.String property)
Removes the given local property from the list of local properties.MaterialModel
set(java.lang.String pname, double value)
Sets the expression for the given property.MaterialModel
set(java.lang.String pname, double[] value)
Sets the expression for the given vector or matrix property.MaterialModel
set(java.lang.String pname, int pos, double value)
Sets the expression at a position for the given vector or matrix property.MaterialModel
set(java.lang.String pname, int pos, java.lang.String value)
Sets the expression at a position for the given vector or matrix property.MaterialModel
set(java.lang.String pname, java.lang.String value)
Sets the expression for the given property.MaterialModel
set(java.lang.String pname, java.lang.String[] value)
Sets the expression for the given vector or matrix property.MaterialModel
setMixingRule(java.lang.String name, java.lang.String mixRule)
Sets the mixing rule for the given material property.MaterialModel
setPropertyInfo(java.lang.String name, java.lang.String info)
Sets the property info (references, temperature conditions, etc.) for the given material property.int[]
size(java.lang.String name)
Returns the size of the stored property, which usually is 1-by-1, 3-by-1 or 3-by-3, but other sizes are supported.MaterialModel
size(java.lang.String name, int[] size)
Sets the size of the stored property.-
Methods inherited from interface com.comsol.model.physics.EquationViewParent
featureInfo, featureInfo
-
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.ParameterContainer
commands, param, params, runCommand
-
Methods inherited from interface com.comsol.model.ParameterEntity
getAllowedPropertyValues, getBoolean, getDblStringArray, getDouble, getDoubleArray, getDoubleMatrix, getExtraSelectionNames, getStringMatrix, hasProperty, properties, selection, set, set, set, set, set, set, set, set, set, set, set, set, set, setIndex, setIndex, setIndex, setIndex, setIndex, setIndex, setIndex, setIndex, setIndex, setIndex
-
Methods inherited from interface com.comsol.model.PrimitiveModelEntity
getContainer, getDisplayString, resolveModelPath
-
Methods inherited from interface com.comsol.model.SelectionEntity
selection
-
-
-
-
Method Detail
-
addInput
MaterialModel addInput(java.lang.String quantity)
Adds a new model input to the material model of the given quantity.- Parameters:
quantity
- Added quantity.- Returns:
- Material model.
-
addinput
@Deprecated MaterialModel addinput(java.lang.String arg0)
Deprecated.UseaddInput(String)
instead.
-
descr
java.lang.String descr(java.lang.String name)
Gets the description of the given property.- Parameters:
name
- Property name.- Returns:
- String value.
-
descr
MaterialModel descr(java.lang.String name, java.lang.String descr)
Sets the description for the given property.- Parameters:
name
- Property name.descr
- Description.- Returns:
- Material Model.
-
func
FunctionFeatureList func()
Returns list of function objects.- Returns:
- List of function object.
-
func
FunctionFeature func(java.lang.String tag)
Returns the function object with the given tag.- Parameters:
tag
- Function object tag.- Returns:
- Function object.
-
getMixingRule
java.lang.String getMixingRule(java.lang.String name)
Returns the mixing rule for the given material property.- Parameters:
name
- Property name.- Returns:
- Mixing rule.
-
getPropertyInfo
java.lang.String getPropertyInfo(java.lang.String name)
Returns the property info (references, temperature conditions, etc.) for the given material property.- Parameters:
name
- Property name.- Returns:
- Property information.
-
getString
java.lang.String getString(java.lang.String name)
Returns the string value of the given property. If it is a vector or matrix quantity, the first value is returned.- Specified by:
getString
in interfaceParameterEntity
- Parameters:
name
- Property name.- Returns:
- String value.
-
getStringArray
java.lang.String[] getStringArray(java.lang.String name)
Returns the string array value of the given property. Matrix values are returned in a columnwise order.- Specified by:
getStringArray
in interfaceParameterEntity
- Parameters:
name
- Property name.- Returns:
- String value array.
-
getType
java.lang.String getType()
Returns the type of the property group.- Returns:
- Type identifier.
-
getValueType
java.lang.String getValueType(java.lang.String name)
Returns the main data type that a property can return. The data types are:
String,
StringArray,
StringMatrix.- Specified by:
getValueType
in interfaceParameterEntity
- Parameters:
name
- Property name.- Returns:
- Data type.
-
hasParam
boolean hasParam(java.lang.String name)
Returns true if the property is defined by the material model.- Specified by:
hasParam
in interfaceParameterContainer
- Parameters:
name
- Property name.- Returns:
true
if the material model defines the parameter.
-
identifier
java.lang.String identifier()
Returns the name of the property group.- Returns:
- The name of the property group.
-
identifier
MaterialModel identifier(java.lang.String name)
Sets the name of the property group to make it different from the tag. Changing the tag withModelEntity.tag(String)
always makes the tag and name the same.- Parameters:
name
- New name.- Returns:
- Material property group.
-
info
InformationList info()
Returns the information objects for the material model.- Returns:
- Information objects.
-
info
Information info(java.lang.String tag)
Returns the information object for the material model.- Parameters:
tag
- Information object tag.- Returns:
- Information object.
-
input
java.lang.String[] input()
Returns the list of model inputs.- Returns:
- List of model inputs.
-
removeInput
MaterialModel removeInput(java.lang.String quantity)
Removes the given quantity from the list of model inputs.- Parameters:
quantity
- The quantity to remove.- Returns:
- Material model.
-
removeOutput
MaterialModel removeOutput(java.lang.String quantity)
Removes the given output quantity from the list of outputs.- Parameters:
quantity
- Quantity to remove.- Returns:
- Material model.
-
removeParam
MaterialModel removeParam(java.lang.String property)
Removes the given local property from the list of local properties.- Parameters:
property
- Property to remove.- Returns:
- Material model.
-
removeinput
@Deprecated MaterialModel removeinput(java.lang.String arg0)
Deprecated.UseremoveInput(String)
instead.
-
set
MaterialModel set(java.lang.String pname, java.lang.String value)
Sets the expression for the given property. The expression can use local names for the properties, parameters, and model inputs.- Specified by:
set
in interfaceParameterEntity
- Parameters:
pname
- Property name.value
- Expression value.- Returns:
- Material Model.
-
set
MaterialModel set(java.lang.String pname, java.lang.String[] value)
Sets the expression for the given vector or matrix property. The expression can use local names for the properties, parameters, and model inputs. Isotropic matrices only require one element or a string, diagonal matrices require three elements, and so forth. Vectors always require three elements.- Specified by:
set
in interfaceParameterEntity
- Parameters:
pname
- Property name.value
- Expression value.- Returns:
- Material Model.
-
set
MaterialModel set(java.lang.String pname, double value)
Sets the expression for the given property. The expression can use local names for the properties, parameters, and model inputs.- Specified by:
set
in interfaceParameterEntity
- Parameters:
pname
- Property name.value
- Expression value.- Returns:
- Material Model.
-
set
MaterialModel set(java.lang.String pname, double[] value)
Sets the expression for the given vector or matrix property. The expression can use local names for the properties, parameters, and model inputs. Isotropic matrices only require one element or a string, diagonal matrices require three elements, and so forth. Vectors always require three elements.- Specified by:
set
in interfaceParameterEntity
- Parameters:
pname
- Property name.value
- Expression value.- Returns:
- Material Model.
-
set
MaterialModel set(java.lang.String pname, int pos, java.lang.String value)
Sets the expression at a position for the given vector or matrix property. The expression can use local names for the properties, parameters, and model inputs.- Specified by:
set
in interfaceParameterEntity
- Parameters:
pname
- Property name.pos
- Position.value
- Expression value.- Returns:
- Material Model.
-
set
MaterialModel set(java.lang.String pname, int pos, double value)
Sets the expression at a position for the given vector or matrix property. The expression can use local names for the properties, parameters, and model inputs.- Specified by:
set
in interfaceParameterEntity
- Parameters:
pname
- Property name.pos
- Position.value
- Expression value.- Returns:
- Material Model.
-
setMixingRule
MaterialModel setMixingRule(java.lang.String name, java.lang.String mixRule)
Sets the mixing rule for the given material property.- Parameters:
name
- Property name.mixRule
- Mixing rule.- Returns:
- Material model.
-
setPropertyInfo
MaterialModel setPropertyInfo(java.lang.String name, java.lang.String info)
Sets the property info (references, temperature conditions, etc.) for the given material property.- Parameters:
name
- Property name.info
- Information about the property.- Returns:
- Material Model.
-
size
int[] size(java.lang.String name)
Returns the size of the stored property, which usually is 1-by-1, 3-by-1 or 3-by-3, but other sizes are supported.- Parameters:
name
- Property name.- Returns:
- Rank vector.
-
size
MaterialModel size(java.lang.String name, int[] size)
Sets the size of the stored property.- Parameters:
name
- Property name.size
- Rank vector.- Returns:
- Material Model.
-
-