com.comsol.model

Interface MaterialModel

All Superinterfaces:

EquationViewParent, ModelEntity, ParameterContainer, PrimitiveModelEntity

public interface MaterialModel
extends ModelEntity, ParameterContainer, EquationViewParent

Material property group.

Method Summary

Modifier and Type	Method and Description
MaterialModel	addinput(java.lang.String arg0) Deprecated. Use addInput(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 pname) Gets the description of the given property.
MaterialModel	descr(java.lang.String pname, 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	getString(java.lang.String pname) Returns the string value of the given parameter.
java.lang.String[]	getStringArray(java.lang.String pname) Returns the string array value of the given parameter.
java.lang.String	getValueType(java.lang.String name) Returns the main data type which a parameter can return.
boolean	hasParam(java.lang.String pname) Returns true if the parameter is defined by the material model.
java.lang.String	identifier() Deprecated. Use ModelEntity.tag() instead.
MaterialModel	identifier(java.lang.String arg0) Deprecated. Use ModelEntity.tag(String) instead.
InformationList	info() Returns the information objects for the material model.
Information	info(java.lang.String name) 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. Use removeInput(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.
int[]	size(java.lang.String pname) Returns the size of the stored parameter, which usually is 1-by-1, 3-by-1 or 3-by-3, but other sizes are supported.
MaterialModel	size(java.lang.String pname, int[] size) Sets the size of the stored parameter.

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

Methods inherited from interface com.comsol.model.ParameterContainer

commands, param, params, runCommand

Methods inherited from interface com.comsol.model.physics.EquationViewParent

featureInfo, featureInfo

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. Use addInput(String) instead.

descr

java.lang.String descr(java.lang.String pname)

Gets the description of the given property.

Parameters:

pname - Property name.

Returns:

String value.

descr

MaterialModel descr(java.lang.String pname,
                    java.lang.String descr)

Sets the description for the given property.

Parameters:

pname - 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.

getString

java.lang.String getString(java.lang.String pname)

Returns the string value of the given parameter. If it is a vector or matrix quantity, the first value is returned.

Parameters:

pname - Parameter name.

Returns:

String value.

getStringArray

java.lang.String[] getStringArray(java.lang.String pname)

Returns the string array value of the given parameter. Matrix values are returned in a columnwise order.

Parameters:

pname - Parameter name.

Returns:

String value array.

getValueType

java.lang.String getValueType(java.lang.String name)

Returns the main data type which a parameter can return. The data types are:
String,
StringArray,
StringMatrix.

Parameters:

name - Parameter name.

Returns:

Data type.

hasParam

boolean hasParam(java.lang.String pname)

Returns true if the parameter is defined by the material model.

Specified by:

hasParam in interface ParameterContainer

Parameters:

pname - Parameter name.

Returns:

true if the material model defines the parameter.

identifier

@Deprecated
java.lang.String identifier()

Deprecated. Use ModelEntity.tag() instead.

identifier

@Deprecated
MaterialModel identifier(java.lang.String arg0)

Deprecated. Use ModelEntity.tag(String) instead.

info

InformationList info()

Returns the information objects for the material model.

Returns:

Information objects.

info

Information info(java.lang.String name)

Returns the information object for the material model.

Parameters:

name - 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. Use removeInput(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.

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.

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.

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.

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.

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.

Parameters:

pname - Property name.

pos - Position.

value - Expression value.

Returns:

Material Model.

size

int[] size(java.lang.String pname)

Returns the size of the stored parameter, which usually is 1-by-1, 3-by-1 or 3-by-3, but other sizes are supported.

Parameters:

pname - Parameter name.

Returns:

Rank vector.

size

MaterialModel size(java.lang.String pname,
                   int[] size)

Sets the size of the stored parameter.

Parameters:

pname - Parameter name.

size - Rank vector.

Returns:

Material Model.