Class FlashResult

java.lang.Object

neqsim.mcp.model.FlashResult

public class FlashResult
extends Object

Typed result model for flash calculations.

Contains the flash metadata (model, flash type, number of phases, phase names) and the full fluid response. This object is the typed counterpart to the JSON returned by FlashRunner.run(String).

Version:

1.0

Author:

Even Solbraa

Field Summary

Fields

Modifier and Type	Field	Description
private final String	flashType
private final FluidResponse	fluidResponse
private final String	model
private final int	numberOfPhases
private final List<String>	phases

Constructor Summary

Constructors

Constructor	Description
FlashResult(String model, String flashType, int numberOfPhases, List<String> phases, FluidResponse fluidResponse)	Creates a flash result.

Method Summary

Modifier and Type	Method	Description
String	getFlashType()	Gets the flash type that was performed.
FluidResponse	getFluidResponse()	Gets the full fluid response.
String	getModel()	Gets the thermodynamic model name.
int	getNumberOfPhases()	Gets the number of phases found.
List<String>	getPhases()	Gets the list of phase names.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

model

private final String model

flashType

private final String flashType

numberOfPhases

private final int numberOfPhases

phases

private final List<String> phases

fluidResponse

private final FluidResponse fluidResponse

Constructor Details

FlashResult

public FlashResult(String model,
 String flashType,
 int numberOfPhases,
 List<String> phases,
 FluidResponse fluidResponse)

Creates a flash result.

Parameters:

model - the thermodynamic model name

flashType - the flash type performed

numberOfPhases - the number of phases found

phases - the list of phase names

fluidResponse - the full fluid response

Method Details

getModel

public String getModel()

Gets the thermodynamic model name.

Returns:

the model

getFlashType

public String getFlashType()

Gets the flash type that was performed.

Returns:

the flash type

getNumberOfPhases

public int getNumberOfPhases()

Gets the number of phases found.

Returns:

the phase count

getPhases

public List<String> getPhases()

Gets the list of phase names.

Returns:

the phase name list

getFluidResponse

public FluidResponse getFluidResponse()

Gets the full fluid response.

Returns:

the FluidResponse object