Package com.comsol.model.physics

Interface PhysicsProp

All Superinterfaces:

ModelEntity, ParameterContainer, PrimitiveModelEntity

public interface PhysicsProp
extends ModelEntity, ParameterContainer

Physics property.

Method Summary

Modifier and Type	Method	Description
java.lang.String[]	getAllowedPropertyValues(java.lang.String name)	Returns the set of allowed values for a property if it is a finite set of strings, null otherwise.
boolean	getBoolean(java.lang.String name)	Returns the value as a boolean.
java.lang.String[][]	getDblStringArray(java.lang.String name)	Returns the value as a matrix of strings.
double[]	getDoubleArray(java.lang.String name)	Returns the value as a vector of doubles.
double[][]	getDoubleMatrix(java.lang.String name)	Returns the value as a matrix of doubles.
java.lang.String	getString(java.lang.String name)	Returns the value as a string.
java.lang.String[]	getStringArray(java.lang.String name)	Returns the value as a vector of strings.
java.lang.String[][]	getStringMatrix(java.lang.String name)	Returns the value as a matrix of strings.
java.lang.String	getValueType(java.lang.String name)	Returns the main data type which a parameter can return.
boolean	hasProperty(java.lang.String name)	Returns true if this feature supports a given property.
java.lang.String[]	properties()	Returns the names of all properties.
PhysicsProp	set(java.lang.String name, boolean value)	Sets the value as a boolean value.
PhysicsProp	set(java.lang.String pname, double value)	Sets the value as a double value.
PhysicsProp	set(java.lang.String pname, double[] value)	Sets the value as a double vector value.
PhysicsProp	set(java.lang.String pname, double[][] value)	Sets the value as a double matrix value.
PhysicsProp	set(java.lang.String pname, int value)	Sets the value as an integer value.
PhysicsProp	set(java.lang.String pname, int[] value)	Sets the value as an integer vector value.
PhysicsProp	set(java.lang.String pname, int[][] value)	Sets the value as an integer matrix value.
PhysicsProp	set(java.lang.String pname, int pos, double value)	Sets the value at a position in a double vector value.
PhysicsProp	set(java.lang.String pname, int pos, double[] value)	Sets the value at a position in a double matrix value.
PhysicsProp	set(java.lang.String pname, int pos, int value)	Sets the value at a position in an integer vector value.
PhysicsProp	set(java.lang.String pname, int pos, int[] value)	Sets the value at a position in an integer matrix value.
PhysicsProp	set(java.lang.String pname, int pos1, int pos2, double value)	Sets the value at a position in a double matrix value.
PhysicsProp	set(java.lang.String pname, int pos1, int pos2, int value)	Sets the value at a position in an integer matrix value.
PhysicsProp	set(java.lang.String pname, int pos1, int pos2, java.lang.String value)	Sets the value at a position in a string matrix value.
PhysicsProp	set(java.lang.String pname, int pos, java.lang.String value)	Sets the value at a position in a string vector value.
PhysicsProp	set(java.lang.String pname, int pos, java.lang.String[] value)	Sets the value at a position in a string matrix value.
PhysicsProp	set(java.lang.String pname, java.lang.String value)	Sets the value as a string value.
PhysicsProp	set(java.lang.String pname, java.lang.String[] value)	Sets the value as a string vector value.
PhysicsProp	set(java.lang.String pname, java.lang.String[][] value)	Sets the value as a string matrix value.
PhysicsProp	setIndex(java.lang.String name, boolean value, int index)	Sets vector parameter value at index.
PhysicsProp	setIndex(java.lang.String name, double[] value, int index)	Sets double matrix property value at index.
PhysicsProp	setIndex(java.lang.String name, double value, int index)	Sets string vector property value at index.
PhysicsProp	setIndex(java.lang.String name, double value, int firstIndex, int secondIndex)	Sets string matrix property value at index.
PhysicsProp	setIndex(java.lang.String name, int[] value, int index)	Sets integer matrix property value at index.
PhysicsProp	setIndex(java.lang.String name, int value, int index)	Sets string vector property value at index.
PhysicsProp	setIndex(java.lang.String name, int value, int firstIndex, int secondIndex)	Sets string matrix property value at index.
PhysicsProp	setIndex(java.lang.String name, java.lang.String[] value, int index)	Sets string matrix property value at index.
PhysicsProp	setIndex(java.lang.String name, java.lang.String value, int vector)	Sets string vector property value at index.
PhysicsProp	setIndex(java.lang.String name, java.lang.String value, int firstIndex, int secondIndex)	Sets string matrix property value at index.

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, hasParam, param, params, runCommand

Methods inherited from interface com.comsol.model.PrimitiveModelEntity

getContainer, getDisplayString, resolveModelPath

Method Detail

getAllowedPropertyValues

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

Returns the set of allowed values for a property if it is a finite set of strings, null otherwise.

Parameters:

name - Property name.

Returns:

Vector of property values.

getBoolean

boolean getBoolean(java.lang.String name)

Returns the value as a boolean.

Parameters:

name - Parameter name.

Returns:

Boolean value.

getDblStringArray

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

Returns the value as a matrix of strings.

Parameters:

name - Parameter name.

Returns:

String matrix value.

getDoubleArray

double[] getDoubleArray(java.lang.String name)

Returns the value as a vector of doubles.

Parameters:

name - Parameter name.

Returns:

Double vector value.

getDoubleMatrix

double[][] getDoubleMatrix(java.lang.String name)

Returns the value as a matrix of doubles.

Parameters:

name - Parameter name.

Returns:

Double matrix value.

getString

java.lang.String getString(java.lang.String name)

Returns the value as a string.

Parameters:

name - Parameter name.

Returns:

String value.

getStringArray

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

Returns the value as a vector of strings.

Parameters:

name - Parameter name.

Returns:

String vector value.

getStringMatrix

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

Returns the value as a matrix of strings.

Parameters:

name - Parameter name.

Returns:

String matrix value.

getValueType

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

Returns the main data type which a parameter can return.

Parameters:

name - The name of the parameter.

Returns:

Data types: String, StringArray, StringMatrix, DoubleArray, DoubleMatrixy.

hasProperty

boolean hasProperty(java.lang.String name)

Returns true if this feature supports a given property.

Parameters:

name - Property name.

Returns:

true if a feature supports the property.

properties

java.lang.String[] properties()

Returns the names of all properties.

Returns:

Vector of properties.

set

PhysicsProp set(java.lang.String pname,
                java.lang.String value)

Sets the value as a string value.

Parameters:

pname - Parameter name.

value - String value.

Returns:

Physics property.

set

PhysicsProp set(java.lang.String pname,
                java.lang.String[] value)

Sets the value as a string vector value.

Parameters:

pname - Parameter name.

value - String vector value.

Returns:

Physics property.

set

PhysicsProp set(java.lang.String pname,
                java.lang.String[][] value)

Sets the value as a string matrix value.

Parameters:

pname - Parameter name.

value - String matrix value.

Returns:

Physics property.

set

PhysicsProp set(java.lang.String name,
                boolean value)

Sets the value as a boolean value.

Parameters:

name - Parameter name.

value - Boolean value.

Returns:

Parameter entity.

set

PhysicsProp set(java.lang.String pname,
                double value)

Sets the value as a double value.

Parameters:

pname - Parameter name.

value - Double value.

Returns:

Physics property.

set

PhysicsProp set(java.lang.String pname,
                double[] value)

Sets the value as a double vector value.

Parameters:

pname - Parameter name.

value - Double vector value.

Returns:

Physics property.

set

PhysicsProp set(java.lang.String pname,
                double[][] value)

Sets the value as a double matrix value.

Parameters:

pname - Parameter name.

value - Double matrix value.

Returns:

Physics property.

set

PhysicsProp set(java.lang.String pname,
                int value)

Sets the value as an integer value.

Parameters:

pname - Parameter name.

value - Integer value.

Returns:

Physics property.

set

PhysicsProp set(java.lang.String pname,
                int[] value)

Sets the value as an integer vector value.

Parameters:

pname - Parameter name.

value - Integer vector value.

Returns:

Physics property.

set

PhysicsProp set(java.lang.String pname,
                int[][] value)

Sets the value as an integer matrix value.

Parameters:

pname - Parameter name.

value - Integer matrix value.

Returns:

Physics property.

set

PhysicsProp set(java.lang.String pname,
                int pos,
                java.lang.String value)

Sets the value at a position in a string vector value.

Parameters:

pname - Parameter name.

pos - Position in vector (1-based).

value - String vector item value.

Returns:

Physics property.

set

PhysicsProp set(java.lang.String pname,
                int pos,
                java.lang.String[] value)

Sets the value at a position in a string matrix value.

Parameters:

pname - Parameter name.

pos - Position in vector (1-based).

value - String vector value.

Returns:

Physics property.

set

PhysicsProp set(java.lang.String pname,
                int pos,
                double value)

Sets the value at a position in a double vector value.

Parameters:

pname - Parameter name.

pos - Position in vector (1-based).

value - Double vector item value.

Returns:

Physics property.

set

PhysicsProp set(java.lang.String pname,
                int pos,
                double[] value)

Sets the value at a position in a double matrix value.

Parameters:

pname - Parameter name.

pos - Position in vector (1-based).

value - Double vector value.

Returns:

Physics property.

set

PhysicsProp set(java.lang.String pname,
                int pos,
                int value)

Sets the value at a position in an integer vector value.

Parameters:

pname - Parameter name.

pos - Position in vector (1-based).

value - Double vector item value.

Returns:

Physics property.

set

PhysicsProp set(java.lang.String pname,
                int pos,
                int[] value)

Sets the value at a position in an integer matrix value.

Parameters:

pname - Parameter name.

pos - Position in vector (1-based).

value - Integer vector value.

Returns:

Physics property.

set

PhysicsProp set(java.lang.String pname,
                int pos1,
                int pos2,
                java.lang.String value)

Sets the value at a position in a string matrix value.

Parameters:

pname - Parameter name.

pos1 - First index of position in matrix (1-based).

pos2 - Second index of position in matrix (1-based).

value - String matrix item value.

Returns:

Physics property.

set

PhysicsProp set(java.lang.String pname,
                int pos1,
                int pos2,
                double value)

Sets the value at a position in a double matrix value.

Parameters:

pname - Parameter name.

pos1 - First index of position in matrix (1-based).

pos2 - Second index of position in matrix (1-based).

value - Double matrix item value.

Returns:

Physics property.

set

PhysicsProp set(java.lang.String pname,
                int pos1,
                int pos2,
                int value)

Sets the value at a position in an integer matrix value.

Parameters:

pname - Parameter name.

pos1 - First index of position in matrix (1-based).

pos2 - Second index of position in matrix (1-based).

value - Integer matrix item value.

Returns:

Physics property.

setIndex

PhysicsProp setIndex(java.lang.String name,
                     java.lang.String value,
                     int vector)

Sets string vector property value at index.

Parameters:

name - Property name.

value - Property value.

vector - Index in vector (0-based).

Returns:

Property.

setIndex

PhysicsProp setIndex(java.lang.String name,
                     java.lang.String[] value,
                     int index)

Sets string matrix property value at index.

Parameters:

name - Property name.

value - Property value.

index - Index in matrix (0-based).

Returns:

Property.

setIndex

PhysicsProp setIndex(java.lang.String name,
                     boolean value,
                     int index)

Sets vector parameter value at index.

Parameters:

name - Property name.

value - Property value.

index - Index in vector (0-based).

Returns:

Property.

setIndex

PhysicsProp setIndex(java.lang.String name,
                     double value,
                     int index)

Sets string vector property value at index.

Parameters:

name - Property name.

value - Property value.

index - Index in vector (0-based).

Returns:

Property.

setIndex

PhysicsProp setIndex(java.lang.String name,
                     double[] value,
                     int index)

Sets double matrix property value at index.

Parameters:

name - Property name.

value - Property value.

index - Index in matrix (0-based).

Returns:

Property.

setIndex

PhysicsProp setIndex(java.lang.String name,
                     int value,
                     int index)

Sets string vector property value at index.

Parameters:

name - Property name.

value - Property value (0-based).

index - Index in vector (0-based).

Returns:

Property.

setIndex

PhysicsProp setIndex(java.lang.String name,
                     int[] value,
                     int index)

Sets integer matrix property value at index.

Parameters:

name - Property name.

value - Property value.

index - Index in matrix.

Returns:

Property.

setIndex

PhysicsProp setIndex(java.lang.String name,
                     java.lang.String value,
                     int firstIndex,
                     int secondIndex)

Sets string matrix property value at index.

Parameters:

name - Property name.

value - Property value.

firstIndex - First index in matrix (0-based).

secondIndex - Second index in matrix (0-based).

Returns:

Property.

setIndex

PhysicsProp setIndex(java.lang.String name,
                     double value,
                     int firstIndex,
                     int secondIndex)

Sets string matrix property value at index.

Parameters:

name - Property name.

value - Property value.

firstIndex - First index in matrix (0-based).

secondIndex - Second index in matrix (0-based).

Returns:

Property.

setIndex

PhysicsProp setIndex(java.lang.String name,
                     int value,
                     int firstIndex,
                     int secondIndex)

Sets string matrix property value at index.

Parameters:

name - Property name.

value - Property value.

firstIndex - First index in matrix (0-based).

secondIndex - Second index in matrix (0-based).

Returns:

Property.