Enum Class StateOfMatter
- All Implemented Interfaces:
Serializable, Comparable<StateOfMatter>, Constable
States of matter, a way of relating the PhaseTypes to classical states of matter.
- Author:
- ASMF
-
Nested Class Summary
Nested classes/interfaces inherited from class Enum
Enum.EnumDesc<E> -
Enum Constant Summary
Enum Constants -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic StateOfMatterGet StateOfMatter value from Phasetype object.static booleanCheck if PhaseType object is an asphaltene phase (either solid or liquid).static booleanCheck if PhaseType object is a gas state of matter.static booleanCheck if PhaseType object is a liquid state of matter.static booleanCheck if PhaseType object is a solid state of matter.static StateOfMatterReturns the enum constant of this class with the specified name.static StateOfMatter[]values()Returns an array containing the constants of this enum class, in the order they are declared.
-
Enum Constant Details
-
GAS
-
LIQUID
-
SOLID
-
-
Constructor Details
-
StateOfMatter
private StateOfMatter()
-
-
Method Details
-
values
Returns an array containing the constants of this enum class, in the order they are declared.- Returns:
- an array containing the constants of this enum class, in the order they are declared
-
valueOf
Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)- Parameters:
name- the name of the enum constant to be returned.- Returns:
- the enum constant with the specified name
- Throws:
IllegalArgumentException- if this enum class has no constant with the specified nameNullPointerException- if the argument is null
-
fromPhaseType
Get StateOfMatter value from Phasetype object.- Parameters:
pt- PhaseType object- Returns:
- StateOfMatter object
-
isGas
Check if PhaseType object is a gas state of matter.- Parameters:
pt- PhaseType object to check.- Returns:
- True if pt converts to StateOfMatter.GAS
-
isLiquid
Check if PhaseType object is a liquid state of matter.- Parameters:
pt- PhaseType object to check.- Returns:
- True if pt converts to StateOfMatter.LIQUID
-
isSolid
Check if PhaseType object is a solid state of matter.- Parameters:
pt- PhaseType object to check.- Returns:
- True if pt converts to StateOfMatter.SOLID
-
isAsphaltene
Check if PhaseType object is an asphaltene phase (either solid or liquid).Returns true for both ASPHALTENE (solid asphaltene precipitate) and LIQUID_ASPHALTENE (asphaltene-rich heavy liquid phase in Pedersen's approach).
- Parameters:
pt- PhaseType object to check.- Returns:
- True if pt is ASPHALTENE or LIQUID_ASPHALTENE
-