Fesapi
2.0.0.0
This project provides C++ classes which allow an easy access in import and export to the Energistics standards.
|
#include <FluidCharacterization.h>
Public Types | |
enum | ModelSpecification { CompositionalThermal = 0 , SrkEos = 1 , PengRobinson76Eos = 2 , PengRobinson78Eos = 3 , LohrenzBrayClarkCorrelation = 4 , CSPedersen87 = 5 , CSPedersen84 = 6 , FrictionTheory = 7 , CorrelationThermal = 8 , BergmanSuttonBubblePoint = 9 , DeGhettoBubblePoint = 10 , StandingBubblePoint = 11 , DindorukChristmanBubblePoint = 12 , PetroskyFarshadBubblePoint = 13 } |
Public Types inherited from common::AbstractObject | |
enum | hdfDatatypeEnum { UNKNOWN = 0 , DOUBLE = 1 , FLOAT = 2 , LONG_64 = 3 , ULONG_64 = 4 , INT = 5 , UINT = 6 , SHORT = 7 , USHORT = 8 , CHAR = 9 , UCHAR = 10 } |
Public Member Functions | |
FluidCharacterization (gsoap_resqml2_0_1::eml20__DataObjectReference *partialObject) | |
FluidCharacterization (common::DataObjectRepository *repo, const std::string &guid, const std::string &title) | |
FluidCharacterization (gsoap_eml2_2::prodml21__FluidCharacterization *fromGsoap) | |
~FluidCharacterization () | |
void | setStandardConditions (double temperatureValue, gsoap_eml2_2::eml22__ThermodynamicTemperatureUom temperatureUom, double pressureValue, gsoap_eml2_2::eml22__PressureUom pressureUom) |
bool | hasStandardConditions () const |
double | getStandardTemperatureValue () const |
gsoap_eml2_2::eml22__ThermodynamicTemperatureUom | getStandardTemperatureUom () const |
double | getStandardPressureValue () const |
gsoap_eml2_2::eml22__PressureUom | getStandardPressureUom () const |
void | setRockFluidUnit (resqml2::RockFluidUnitInterpretation *rockFluidUnit) |
common::DataObjectReference | getRockFluidUnitDor () const |
resqml2::RockFluidUnitInterpretation * | getRockFluidUnit () const |
void | setFluidSystem (class FluidSystem *fluidSystem) |
common::DataObjectReference | getFluidSystemDor () const |
class FluidSystem * | getFluidSystem () const |
unsigned int | getFormationWaterCount () const |
void | pushBackFormationWater (const std::string &uid) |
unsigned int | getPureFluidComponentCount () const |
void | pushBackPureFluidComponent (const std::string &uid, gsoap_eml2_2::prodml21__PureComponentEnum kind, bool hydrocarbonFlag) |
unsigned int | getPlusFluidComponentCount () const |
void | pushBackPlusFluidComponent (const std::string &uid, gsoap_eml2_2::prodml21__PlusComponentEnum kind) |
unsigned int | getStockTankOilCount () const |
void | pushBackStockTankOil (const std::string &uid) |
unsigned int | getNaturalGasCount () const |
void | pushBackNaturalGas (const std::string &uid) |
unsigned int | getPseudoFluidComponentCount () const |
void | pushBackPseudoFluidComponent (const std::string &uid, gsoap_eml2_2::prodml21__PseudoComponentEnum kind) |
unsigned int | getModelCount () const |
void | pushBackModel (const std::string &uid="") |
PvtSpecification * | getModelSpecification (unsigned int modelIndex) |
PvtSpecification * | initModelSpecification (unsigned int modelIndex, ModelSpecification kind) |
unsigned int | getTableFormatCount () const |
void | pushBackTableFormat (const std::string &uid="") |
uint64_t | getTableFormatColumnCount (const std::string &tableFormatUid) const |
std::string | getTableFormatColumnUom (const std::string &tableFormatUid, unsigned int columnIndex) const |
std::string | getTableFormatColumnProperty (const std::string &tableFormatUid, unsigned int columnIndex) const |
void | pushBackTableFormatColumn (unsigned int tableFormatIndex, gsoap_eml2_2::eml22__UnitOfMeasure uom, gsoap_eml2_2::prodml21__OutputFluidProperty fluidProperty) |
void | pushBackTableFormatColumn (unsigned int tableFormatIndex, const std::string &uom, const std::string &fluidProperty) |
unsigned int | getTableCount (unsigned int modelIndex) const |
std::string | getTableName (unsigned int modelIndex, unsigned int tableIndex) const |
std::string | getTableFormatUid (unsigned int modelIndex, unsigned int tableIndex) const |
void | pushBackTable (unsigned int modelIndex, const std::string &name, const std::string &tableFormatUid, const std::string &uid="") |
unsigned int | getTableRowCount (unsigned int modelIndex, unsigned int tableIndex) const |
std::string | getTableRowContent (unsigned int modelIndex, unsigned int tableIndex, unsigned int rowIndex) const |
void | pushBackTableRow (unsigned int modelIndex, unsigned int tableIndex, const std::vector< double > &rowContent) |
void | pushBackTableRow (unsigned int modelIndex, unsigned int tableIndex, const std::vector< double > &rowContent, bool isSaturated) |
void | pushBackParameter (unsigned int modelIndex, double value, gsoap_eml2_2::eml22__UnitOfMeasure uom, gsoap_eml2_2::prodml21__OutputFluidProperty fluidProperty) |
void | pushBackParameter (unsigned int modelIndex, double value, gsoap_eml2_2::eml22__UnitOfMeasure uom, gsoap_eml2_2::prodml21__OutputFluidProperty fluidProperty, gsoap_eml2_2::prodml21__ThermodynamicPhase phase) |
virtual std::string | getXmlTag () const final |
std::string | getXmlNamespace () const final |
void | loadTargetRelationships () final |
Public Member Functions inherited from common::AbstractObject | |
bool | isPartial () const |
virtual bool | isTopLevelElement () const |
std::string | getUuid () const |
std::string | getTitle () const |
std::string | getEditor () const |
time_t | getCreation () const |
tm | getCreationAsTimeStructure () const |
std::string | getOriginator () const |
std::string | getDescription () const |
time_t | getLastUpdate () const |
tm | getLastUpdateAsTimeStructure () const |
std::string | getFormat () const |
std::string | getDescriptiveKeywords () const |
std::string | getVersion () const |
void | setTitle (const std::string &title) |
void | setEditor (const std::string &editor) |
void | setCreation (time_t creation) |
void | setCreation (const tm &creation) |
void | setOriginator (const std::string &originator) |
void | setDescription (const std::string &description) |
void | setLastUpdate (time_t lastUpdate) |
void | setLastUpdate (const tm &lastUpdate) |
void | setDescriptiveKeywords (const std::string &descriptiveKeywords) |
void | setVersion (const std::string &version) |
void | setMetadata (const std::string &title, const std::string &editor, time_t creation, const std::string &originator, const std::string &description, time_t lastUpdate, const std::string &descriptiveKeywords) |
void | serializeIntoStream (std::ostream *stream) |
void | setGsoapProxy (gsoap_resqml2_0_1::eml20__AbstractCitedDataObject *gsoapProxy) |
void | setGsoapProxy (gsoap_eml2_1::eml21__AbstractObject *gsoapProxy) |
gsoap_resqml2_0_1::eml20__AbstractCitedDataObject * | getEml20GsoapProxy () const |
gsoap_eml2_1::eml21__AbstractObject * | getEml21GsoapProxy () const |
gsoap_eml2_2::eml22__AbstractObject * | getEml22GsoapProxy () const |
void | setGsoapProxy (gsoap_eml2_2::eml22__AbstractObject *gsoapProxy) |
gsoap_eml2_3::eml23__AbstractObject * | getEml23GsoapProxy () const |
void | setGsoapProxy (gsoap_eml2_3::eml23__AbstractObject *gsoapProxy) |
soap * | getGsoapContext () const |
int | getGsoapType () const |
gsoap_resqml2_0_1::eml20__DataObjectReference * | newResqmlReference () const |
gsoap_eml2_1::eml21__DataObjectReference * | newEmlReference () const |
gsoap_eml2_2::eml22__DataObjectReference * | newEml22Reference () const |
gsoap_eml2_3::eml23__DataObjectReference * | newEml23Reference () const |
gsoap_resqml2_0_1::resqml20__ContactElementReference * | newContactElementReference2_0_1 () const |
gsoap_eml2_3::resqml22__ContactElement * | newContactElementReference2_2 () const |
common::DataObjectRepository * | getRepository () const |
virtual std::string | getXmlNamespaceVersion () const |
virtual std::string | getContentType () const |
virtual std::string | getQualifiedType () const |
virtual std::string | getPartNameInEpcDocument () const |
std::string | serializeIntoString () |
void | addAlias (const std::string &authority, const std::string &title) |
unsigned int | getAliasCount () const |
std::string | getAliasAuthorityAtIndex (unsigned int index) const |
std::string | getAliasTitleAtIndex (unsigned int index) const |
std::vector< eml2::Activity * > | getActivitySet () const |
unsigned int | getActivityCount () const |
eml2::Activity * | getActivity (unsigned int index) const |
void | pushBackExtraMetadata (const std::string &key, const std::string &value) |
std::unordered_map< std::string, std::string > | getExtraMetadataSet () const |
std::vector< std::string > | getExtraMetadata (const std::string &key) const |
unsigned int | getExtraMetadataCount () const |
std::string | getExtraMetadataKeyAtIndex (unsigned int index) const |
std::string | getExtraMetadataStringValueAtIndex (unsigned int index) const |
Static Public Attributes | |
static const char * | XML_TAG |
static const char * | XML_NS |
Additional Inherited Members | |
Static Public Member Functions inherited from common::AbstractObject | |
static void | setFormat (const std::string &vendor, const std::string &applicationName, const std::string &applicationVersionNumber) |
The fluid characterization data object describes the characteristics and properties of a fluid sample or fluid system under the conditions expected in a historical or future state. Three basic formats are available to represent fluid characterization results for delivery to consumer applications:
Values that represent model specifications
|
inline |
Only to be used in partial transfer context
[in,out] | partialObject | If non-null, the partial object. |
prodml2_1::FluidCharacterization::FluidCharacterization | ( | common::DataObjectRepository * | repo, |
const std::string & | guid, | ||
const std::string & | title | ||
) |
Creates an instance of this class in a gsoap context.
[in,out] | repo | The dataobject repo where the underlying gsoap proxy is going to be created. |
guid | The guid to set to this instance. If empty then a new guid will be generated. | |
title | The title. |
|
inline |
Creates an instance of this class by wrapping a gsoap instance.
[in,out] | fromGsoap | If non-null, from gsoap. |
|
inline |
Destructor does nothing since the memory is managed by the gsoap context.
class FluidSystem* prodml2_1::FluidCharacterization::getFluidSystem | ( | ) | const |
Gets the associated FluidSystem
common::DataObjectReference prodml2_1::FluidCharacterization::getFluidSystemDor | ( | ) | const |
Gets the associated FluidSystem dor
unsigned int prodml2_1::FluidCharacterization::getFormationWaterCount | ( | ) | const |
Gets formation water count
unsigned int prodml2_1::FluidCharacterization::getModelCount | ( | ) | const |
Gets model count
|
inline |
Gets model specification
modelIndex | Zero-based index of the model. |
unsigned int prodml2_1::FluidCharacterization::getNaturalGasCount | ( | ) | const |
Gets natural gas count
unsigned int prodml2_1::FluidCharacterization::getPlusFluidComponentCount | ( | ) | const |
Gets plus fluid component count
unsigned int prodml2_1::FluidCharacterization::getPseudoFluidComponentCount | ( | ) | const |
Gets pseudo fluid component count
unsigned int prodml2_1::FluidCharacterization::getPureFluidComponentCount | ( | ) | const |
Gets pure fluid component count
resqml2::RockFluidUnitInterpretation* prodml2_1::FluidCharacterization::getRockFluidUnit | ( | ) | const |
Gets rock fluid unit
common::DataObjectReference prodml2_1::FluidCharacterization::getRockFluidUnitDor | ( | ) | const |
Gets rock fluid unit dor
gsoap_eml2_2::eml22__PressureUom prodml2_1::FluidCharacterization::getStandardPressureUom | ( | ) | const |
Gets standard pressure uom
double prodml2_1::FluidCharacterization::getStandardPressureValue | ( | ) | const |
Gets standard pressure value
gsoap_eml2_2::eml22__ThermodynamicTemperatureUom prodml2_1::FluidCharacterization::getStandardTemperatureUom | ( | ) | const |
Gets standard temperature uom
double prodml2_1::FluidCharacterization::getStandardTemperatureValue | ( | ) | const |
Gets standard temperature value
unsigned int prodml2_1::FluidCharacterization::getStockTankOilCount | ( | ) | const |
Gets stock tank oil count
unsigned int prodml2_1::FluidCharacterization::getTableCount | ( | unsigned int | modelIndex | ) | const |
Gets the table count
modelIndex | Zero-based index of the model in this fluid characterization. |
uint64_t prodml2_1::FluidCharacterization::getTableFormatColumnCount | ( | const std::string & | tableFormatUid | ) | const |
Gets the count of a table format column
tableFormatUid | The uid of the table format. |
columnIndex | The zero-based index of the column. |
std::string prodml2_1::FluidCharacterization::getTableFormatColumnProperty | ( | const std::string & | tableFormatUid, |
unsigned int | columnIndex | ||
) | const |
Gets the property kind of a table format column
tableFormatUid | The uid of the table format. |
columnIndex | The zero-based index of the column. |
std::string prodml2_1::FluidCharacterization::getTableFormatColumnUom | ( | const std::string & | tableFormatUid, |
unsigned int | columnIndex | ||
) | const |
Gets the uom of a table format column
tableFormatUid | The uid of the table format. |
columnIndex | The zero-based index of the column. |
unsigned int prodml2_1::FluidCharacterization::getTableFormatCount | ( | ) | const |
Gets the table format count
std::string prodml2_1::FluidCharacterization::getTableFormatUid | ( | unsigned int | modelIndex, |
unsigned int | tableIndex | ||
) | const |
Gets the uid of the table format of a table.
modelIndex | Zero-based index of the model in this fluid characterization. |
tableIndex | Zero-based index of the table in a model of this fluid characterization. |
std::string prodml2_1::FluidCharacterization::getTableName | ( | unsigned int | modelIndex, |
unsigned int | tableIndex | ||
) | const |
Gets the name of a table.
modelIndex | Zero-based index of the model in this fluid characterization. |
tableIndex | Zero-based index of the table in a model of this fluid characterization. |
std::string prodml2_1::FluidCharacterization::getTableRowContent | ( | unsigned int | modelIndex, |
unsigned int | tableIndex, | ||
unsigned int | rowIndex | ||
) | const |
Gets the content of a row of a table.
modelIndex | Zero-based index of the model in this fluid characterization. |
tableIndex | Zero-based index of the table in a model of this fluid characterization. |
rowIndex | Zero-based index of the row of the table in a model of this fluid characterization. |
unsigned int prodml2_1::FluidCharacterization::getTableRowCount | ( | unsigned int | modelIndex, |
unsigned int | tableIndex | ||
) | const |
Gets the table row count
modelIndex | Zero-based index of the model in this fluid characterization. |
tableIndex | Zero-based index of the table in a model of this fluid characterization. |
|
inlinefinalvirtual |
Get the standard XML namespace for serializing this data object.
Implements common::AbstractObject.
|
inlinefinalvirtual |
Get the standard XML tag without XML namespace for serializing this data object.
Implements common::AbstractObject.
bool prodml2_1::FluidCharacterization::hasStandardConditions | ( | ) | const |
Query if this object has standard conditions
PvtSpecification* prodml2_1::FluidCharacterization::initModelSpecification | ( | unsigned int | modelIndex, |
ModelSpecification | kind | ||
) |
Return the PvtSpecification according to the kind. Please downcast it and set all attributes which you want.
modelIndex | Zero-based index of the model. |
kind | The kind. |
|
finalvirtual |
Loads target relationships
Implements common::AbstractObject.
void prodml2_1::FluidCharacterization::pushBackFormationWater | ( | const std::string & | uid | ) |
Pushes a back formation water
uid | The UID. |
void prodml2_1::FluidCharacterization::pushBackModel | ( | const std::string & | uid = "" | ) |
Pushes a back model
uid | The UID. If empty, it will be set to its index in this Fluid Characterization |
void prodml2_1::FluidCharacterization::pushBackNaturalGas | ( | const std::string & | uid | ) |
Pushes a back natural gas
uid | The UID. |
void prodml2_1::FluidCharacterization::pushBackParameter | ( | unsigned int | modelIndex, |
double | value, | ||
gsoap_eml2_2::eml22__UnitOfMeasure | uom, | ||
gsoap_eml2_2::prodml21__OutputFluidProperty | fluidProperty | ||
) |
Pushes back a phase-unrelated parameter in a model.
modelIndex | Zero-based index of the model in this fluid characterization. |
value | The value of the parameter |
uom | The uom associated to the value of this parameter |
fluidProperty | The property kind of this value |
void prodml2_1::FluidCharacterization::pushBackParameter | ( | unsigned int | modelIndex, |
double | value, | ||
gsoap_eml2_2::eml22__UnitOfMeasure | uom, | ||
gsoap_eml2_2::prodml21__OutputFluidProperty | fluidProperty, | ||
gsoap_eml2_2::prodml21__ThermodynamicPhase | phase | ||
) |
Pushes back a phase related parameter in a model.
modelIndex | Zero-based index of the model in this fluid characterization. |
value | The value of the parameter |
uom | The uom associated to the value of this parameter |
fluidProperty | The property kind of this value |
phase | The pahse associated to the parameter |
void prodml2_1::FluidCharacterization::pushBackPlusFluidComponent | ( | const std::string & | uid, |
gsoap_eml2_2::prodml21__PlusComponentEnum | kind | ||
) |
Pushes a back plus fluid component
uid | The UID. |
kind | The kind. |
void prodml2_1::FluidCharacterization::pushBackPseudoFluidComponent | ( | const std::string & | uid, |
gsoap_eml2_2::prodml21__PseudoComponentEnum | kind | ||
) |
Pushes a back pseudo fluid component
uid | The UID. |
kind | The kind. |
void prodml2_1::FluidCharacterization::pushBackPureFluidComponent | ( | const std::string & | uid, |
gsoap_eml2_2::prodml21__PureComponentEnum | kind, | ||
bool | hydrocarbonFlag | ||
) |
Pushes a back pure fluid component
uid | The UID. |
kind | The kind. |
hydrocarbonFlag | True to hydrocarbon flag. |
void prodml2_1::FluidCharacterization::pushBackStockTankOil | ( | const std::string & | uid | ) |
Pushes a back stock tank oil
uid | The UID. |
void prodml2_1::FluidCharacterization::pushBackTable | ( | unsigned int | modelIndex, |
const std::string & | name, | ||
const std::string & | tableFormatUid, | ||
const std::string & | uid = "" |
||
) |
Pushes back a table
modelIndex | Zero-based index of the model. |
name | The name of this table. |
tableFormatUid | The UID of the table format this table is using.The table format defines the semantic of the colums and values. |
uid | The UID of this table. If empty, it will be set to its index in this Fluid Characterization |
void prodml2_1::FluidCharacterization::pushBackTableFormat | ( | const std::string & | uid = "" | ) |
Pushes a table format
uid | The UID. If empty, it will be set to its index in this Fluid Characterization |
void prodml2_1::FluidCharacterization::pushBackTableFormatColumn | ( | unsigned int | tableFormatIndex, |
const std::string & | uom, | ||
const std::string & | fluidProperty | ||
) |
Pushes a table format colum
tableFormatIndex | Zero-based index of the table format. |
uom | The uom associated to the values of this column |
fluidProperty | The non standard property name that this column contains |
void prodml2_1::FluidCharacterization::pushBackTableFormatColumn | ( | unsigned int | tableFormatIndex, |
gsoap_eml2_2::eml22__UnitOfMeasure | uom, | ||
gsoap_eml2_2::prodml21__OutputFluidProperty | fluidProperty | ||
) |
Pushes a table format colum
tableFormatIndex | Zero-based index of the table format. |
uom | The uom associated to the values of this column |
fluidProperty | The property that this column contains |
void prodml2_1::FluidCharacterization::pushBackTableRow | ( | unsigned int | modelIndex, |
unsigned int | tableIndex, | ||
const std::vector< double > & | rowContent | ||
) |
Pushes back a row in a table of a model without indicating if the data are either saturated or under-saturated.
modelIndex | Zero-based index of the model in this fluid characterization. |
tableIndex | Zero-based index of the table in a model of this fluid characterization. |
rowContent | The values representing the content of the row in the table. |
void prodml2_1::FluidCharacterization::pushBackTableRow | ( | unsigned int | modelIndex, |
unsigned int | tableIndex, | ||
const std::vector< double > & | rowContent, | ||
bool | isSaturated | ||
) |
Pushes back a row in a table of a model indicating if the data are either saturated or under-saturated.
modelIndex | Zero-based index of the model in this fluid characterization. |
tableIndex | Zero-based index of the table in a model of this fluid characterization. |
rowContent | The values representing the content of the row in the table. |
isSaturated | True if the data correspond to saturated data, false if the data correspond to undersaturated data |
void prodml2_1::FluidCharacterization::setFluidSystem | ( | class FluidSystem * | fluidSystem | ) |
Sets the assocaited fluid system
[in,out] | rockFluidUnit | If non-null, the rock fluid unit. |
void prodml2_1::FluidCharacterization::setRockFluidUnit | ( | resqml2::RockFluidUnitInterpretation * | rockFluidUnit | ) |
Sets rock fluid unit
[in,out] | rockFluidUnit | If non-null, the rock fluid unit. |
void prodml2_1::FluidCharacterization::setStandardConditions | ( | double | temperatureValue, |
gsoap_eml2_2::eml22__ThermodynamicTemperatureUom | temperatureUom, | ||
double | pressureValue, | ||
gsoap_eml2_2::eml22__PressureUom | pressureUom | ||
) |
Sets standard conditions
temperatureValue | The temperature value. |
temperatureUom | The temperature uom. |
pressureValue | The pressure value. |
pressureUom | The pressure uom. |
|
static |
The standard XML namespace for serializing this data object.
|
static |
The standard XML tag without XML namespace for serializing this data object.