FluidCharacterization.h

/*-----------------------------------------------------------------------
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements.  See the NOTICE file
distributed with this work for additional information
regarding copyright ownership.  The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"; you may not use this file except in compliance
with the License.  You may obtain a copy of the License at
 
  http://www.apache.org/licenses/LICENSE-2.0
 
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied.  See the License for the
specific language governing permissions and limitations
under the License.
-----------------------------------------------------------------------*/
#pragma once
 
#include "../common/AbstractObject.h"
 
#include "PvtSpecification.h"
 
namespace RESQML2_NS
{
    class RockFluidUnitInterpretation;
}

#define GETTER_FLUID_CATALOG_COMPONENT_ATTRIBUTE(vectorName, attributeName, attributeDatatype)\
    DLL_IMPORT_OR_EXPORT attributeDatatype get##vectorName##attributeName(unsigned int index) const {\
        if (static_cast<gsoap_eml2_3::prodml22__FluidCharacterization*>(gsoapProxy2_3)->FluidComponentCatalog == nullptr ||\
            static_cast<gsoap_eml2_3::prodml22__FluidCharacterization*>(gsoapProxy2_3)->FluidComponentCatalog->vectorName.size() <= index) { throw std::out_of_range("The index is out of range"); }\
        return static_cast<gsoap_eml2_3::prodml22__FluidCharacterization*>(gsoapProxy2_3)->FluidComponentCatalog->vectorName[index]->attributeName;\
    }

#define GETTER_AND_SETTER_FLUID_CATALOG_COMPONENT_OPTIONAL_ATTRIBUTE(vectorName, attributeName, attributeDatatype)\
    DLL_IMPORT_OR_EXPORT void set##vectorName##attributeName(unsigned int index, const attributeDatatype& value);\
    DLL_IMPORT_OR_EXPORT bool has##vectorName##attributeName(unsigned int index) const {\
        return  static_cast<gsoap_eml2_3::prodml22__FluidCharacterization*>(gsoapProxy2_3)->FluidComponentCatalog != nullptr &&\
                static_cast<gsoap_eml2_3::prodml22__FluidCharacterization*>(gsoapProxy2_3)->FluidComponentCatalog->vectorName.size() > index &&\
                static_cast<gsoap_eml2_3::prodml22__FluidCharacterization*>(gsoapProxy2_3)->FluidComponentCatalog->vectorName[index]->attributeName != nullptr;\
    }\
    DLL_IMPORT_OR_EXPORT attributeDatatype get##vectorName##attributeName(unsigned int index) const {\
        if (!has##vectorName##attributeName(index)) { throw std::out_of_range("The index is out of range"); }\
        return *static_cast<gsoap_eml2_3::prodml22__FluidCharacterization*>(gsoapProxy2_3)->FluidComponentCatalog->vectorName[index]->attributeName;\
    }

#define GETTER_AND_SETTER_FLUID_CATALOG_COMPONENT_MEASURE_ATTRIBUTE(vectorName, attributeName, uomDatatype)\
    DLL_IMPORT_OR_EXPORT void set##vectorName##attributeName(unsigned int index, double value, uomDatatype uom);\
    DLL_IMPORT_OR_EXPORT bool has##vectorName##attributeName(unsigned int index) const {\
        return  static_cast<gsoap_eml2_3::prodml22__FluidCharacterization*>(gsoapProxy2_3)->FluidComponentCatalog != nullptr &&\
                static_cast<gsoap_eml2_3::prodml22__FluidCharacterization*>(gsoapProxy2_3)->FluidComponentCatalog->vectorName.size() > index &&\
                static_cast<gsoap_eml2_3::prodml22__FluidCharacterization*>(gsoapProxy2_3)->FluidComponentCatalog->vectorName[index]->attributeName != nullptr;\
    }\
    DLL_IMPORT_OR_EXPORT double get##vectorName##attributeName##Value(unsigned int index) const {\
        if (!has##vectorName##attributeName(index)) { throw std::out_of_range("The index is out of range"); }\
        return static_cast<gsoap_eml2_3::prodml22__FluidCharacterization*>(gsoapProxy2_3)->FluidComponentCatalog->vectorName[index]->attributeName->__item;\
    }\
    DLL_IMPORT_OR_EXPORT uomDatatype get##vectorName##attributeName##Uom(unsigned int index) const {\
        if (!has##vectorName##attributeName(index)) { throw std::out_of_range("The index is out of range"); }\
        return static_cast<gsoap_eml2_3::prodml22__FluidCharacterization*>(gsoapProxy2_3)->FluidComponentCatalog->vectorName[index]->attributeName->uom;\
    }

#define GETTER_AND_SETTER_FLUID_CATALOG_COMPONENT_COMMON_ATTRIBUTES(vectorName)\
    GETTER_FLUID_CATALOG_COMPONENT_ATTRIBUTE(vectorName, uid, std::string)\
    GETTER_AND_SETTER_FLUID_CATALOG_COMPONENT_OPTIONAL_ATTRIBUTE(vectorName, Remark, std::string)\
    GETTER_AND_SETTER_FLUID_CATALOG_COMPONENT_MEASURE_ATTRIBUTE(vectorName, MassFraction, gsoap_eml2_3::eml23__MassPerMassUom)\
    GETTER_AND_SETTER_FLUID_CATALOG_COMPONENT_MEASURE_ATTRIBUTE(vectorName, MoleFraction, gsoap_eml2_3::eml23__AmountOfSubstancePerAmountOfSubstanceUom)
 
namespace PRODML2_2_NS
{
    class FluidCharacterization : public COMMON_NS::AbstractObject
    {
    public:

        DLL_IMPORT_OR_EXPORT FluidCharacterization(gsoap_resqml2_0_1::eml20__DataObjectReference* partialObject) : COMMON_NS::AbstractObject(partialObject) {}

        FluidCharacterization(COMMON_NS::DataObjectRepository * repo,
            const std::string & guid,
            const std::string & title);

        FluidCharacterization(gsoap_eml2_3::prodml22__FluidCharacterization* fromGsoap):AbstractObject(fromGsoap)  {}

        ~FluidCharacterization() {
            for (size_t i = 0; i < modelSpecifications.size(); ++i) {
                if (modelSpecifications[i] != nullptr) {
                    delete modelSpecifications[i];
                }
            }
        }
 
        GETTER_SETTER_OPTIONAL_ATTRIBUTE(gsoap_eml2_3::prodml22__FluidCharacterization, gsoapProxy2_3, Kind, std::string)
        GETTER_SETTER_OPTIONAL_ATTRIBUTE(gsoap_eml2_3::prodml22__FluidCharacterization, gsoapProxy2_3, IntendedUsage, std::string)
        GETTER_SETTER_OPTIONAL_ATTRIBUTE(gsoap_eml2_3::prodml22__FluidCharacterization, gsoapProxy2_3, Remark, std::string)
 
        
        DLL_IMPORT_OR_EXPORT void setStandardConditions(double temperatureValue, gsoap_eml2_3::eml23__ThermodynamicTemperatureUom temperatureUom,
            double pressureValue, gsoap_eml2_3::eml23__PressureUom pressureUom);

        DLL_IMPORT_OR_EXPORT bool hasStandardConditions() const;

        DLL_IMPORT_OR_EXPORT double getStandardTemperatureValue() const;

        DLL_IMPORT_OR_EXPORT gsoap_eml2_3::eml23__ThermodynamicTemperatureUom getStandardTemperatureUom() const;

        DLL_IMPORT_OR_EXPORT double getStandardPressureValue() const;

        DLL_IMPORT_OR_EXPORT gsoap_eml2_3::eml23__PressureUom getStandardPressureUom() const;

        DLL_IMPORT_OR_EXPORT void setRockFluidUnit(RESQML2_NS::RockFluidUnitInterpretation* rockFluidUnit);

        COMMON_NS::DataObjectReference getRockFluidUnitDor() const;

        DLL_IMPORT_OR_EXPORT RESQML2_NS::RockFluidUnitInterpretation* getRockFluidUnit() const;

        DLL_IMPORT_OR_EXPORT void setFluidSystem(class FluidSystem* fluidSystem);

        COMMON_NS::DataObjectReference getFluidSystemDor() const;

        DLL_IMPORT_OR_EXPORT class FluidSystem* getFluidSystem() const;

        DLL_IMPORT_OR_EXPORT unsigned int getFormationWaterCount() const;

        DLL_IMPORT_OR_EXPORT void pushBackFormationWater(const std::string & uid);
        GETTER_AND_SETTER_FLUID_CATALOG_COMPONENT_COMMON_ATTRIBUTES(FormationWater)
        GETTER_AND_SETTER_FLUID_CATALOG_COMPONENT_MEASURE_ATTRIBUTE(FormationWater, Salinity, gsoap_eml2_3::eml23__MassPerMassUom)
        GETTER_AND_SETTER_FLUID_CATALOG_COMPONENT_OPTIONAL_ATTRIBUTE(FormationWater, SpecificGravity, double)

        DLL_IMPORT_OR_EXPORT unsigned int getPureFluidComponentCount() const;

        DLL_IMPORT_OR_EXPORT void pushBackPureFluidComponent(const std::string & uid, gsoap_eml2_3::prodml22__PureComponentKind kind, bool hydrocarbonFlag);
        GETTER_AND_SETTER_FLUID_CATALOG_COMPONENT_COMMON_ATTRIBUTES(PureFluidComponent)
        GETTER_FLUID_CATALOG_COMPONENT_ATTRIBUTE(PureFluidComponent, Kind, std::string)
        GETTER_FLUID_CATALOG_COMPONENT_ATTRIBUTE(PureFluidComponent, HydrocarbonFlag, bool)
        GETTER_AND_SETTER_FLUID_CATALOG_COMPONENT_MEASURE_ATTRIBUTE(PureFluidComponent, MolecularWeight, gsoap_eml2_3::eml23__MolecularWeightUom)

        DLL_IMPORT_OR_EXPORT unsigned int getPlusFluidComponentCount() const;

        DLL_IMPORT_OR_EXPORT void pushBackPlusFluidComponent(const std::string & uid, gsoap_eml2_3::prodml22__PlusComponentKind kind);
        GETTER_AND_SETTER_FLUID_CATALOG_COMPONENT_COMMON_ATTRIBUTES(PlusFluidComponent)
        GETTER_AND_SETTER_FLUID_CATALOG_COMPONENT_OPTIONAL_ATTRIBUTE(PlusFluidComponent, SpecificGravity, double)
        GETTER_AND_SETTER_FLUID_CATALOG_COMPONENT_OPTIONAL_ATTRIBUTE(PlusFluidComponent, StartingCarbonNumber, int64_t)
        GETTER_AND_SETTER_FLUID_CATALOG_COMPONENT_MEASURE_ATTRIBUTE(PlusFluidComponent, StartingBoilingPoint, gsoap_eml2_3::eml23__ThermodynamicTemperatureUom)
        GETTER_AND_SETTER_FLUID_CATALOG_COMPONENT_MEASURE_ATTRIBUTE(PlusFluidComponent, AvgDensity, std::string)
        GETTER_AND_SETTER_FLUID_CATALOG_COMPONENT_MEASURE_ATTRIBUTE(PlusFluidComponent, AvgMolecularWeight, gsoap_eml2_3::eml23__MolecularWeightUom)

        DLL_IMPORT_OR_EXPORT unsigned int getStockTankOilCount() const;

        DLL_IMPORT_OR_EXPORT void pushBackStockTankOil(const std::string & uid);
        GETTER_AND_SETTER_FLUID_CATALOG_COMPONENT_COMMON_ATTRIBUTES(StockTankOil)
        GETTER_AND_SETTER_FLUID_CATALOG_COMPONENT_MEASURE_ATTRIBUTE(StockTankOil, APIGravity, gsoap_eml2_3::eml23__APIGravityUom)
        GETTER_AND_SETTER_FLUID_CATALOG_COMPONENT_MEASURE_ATTRIBUTE(StockTankOil, MolecularWeight, gsoap_eml2_3::eml23__MolecularWeightUom)
        GETTER_AND_SETTER_FLUID_CATALOG_COMPONENT_MEASURE_ATTRIBUTE(StockTankOil, GrossEnergyContentPerUnitMass, gsoap_eml2_3::eml23__EnergyPerMassUom)
        GETTER_AND_SETTER_FLUID_CATALOG_COMPONENT_MEASURE_ATTRIBUTE(StockTankOil, NetEnergyContentPerUnitMass, gsoap_eml2_3::eml23__EnergyPerMassUom)
        GETTER_AND_SETTER_FLUID_CATALOG_COMPONENT_MEASURE_ATTRIBUTE(StockTankOil, GrossEnergyContentPerUnitVolume, gsoap_eml2_3::eml23__EnergyPerVolumeUom)
        GETTER_AND_SETTER_FLUID_CATALOG_COMPONENT_MEASURE_ATTRIBUTE(StockTankOil, NetEnergyContentPerUnitVolume, gsoap_eml2_3::eml23__EnergyPerVolumeUom)

        DLL_IMPORT_OR_EXPORT unsigned int getNaturalGasCount() const;

        DLL_IMPORT_OR_EXPORT void pushBackNaturalGas(const std::string & uid);
        GETTER_AND_SETTER_FLUID_CATALOG_COMPONENT_COMMON_ATTRIBUTES(NaturalGas)
        GETTER_AND_SETTER_FLUID_CATALOG_COMPONENT_OPTIONAL_ATTRIBUTE(NaturalGas, GasGravity, double)
        GETTER_AND_SETTER_FLUID_CATALOG_COMPONENT_MEASURE_ATTRIBUTE(NaturalGas, MolecularWeight, gsoap_eml2_3::eml23__MolecularWeightUom)
        GETTER_AND_SETTER_FLUID_CATALOG_COMPONENT_MEASURE_ATTRIBUTE(NaturalGas, GrossEnergyContentPerUnitMass, gsoap_eml2_3::eml23__EnergyPerMassUom)
        GETTER_AND_SETTER_FLUID_CATALOG_COMPONENT_MEASURE_ATTRIBUTE(NaturalGas, NetEnergyContentPerUnitMass, gsoap_eml2_3::eml23__EnergyPerMassUom)
        GETTER_AND_SETTER_FLUID_CATALOG_COMPONENT_MEASURE_ATTRIBUTE(NaturalGas, GrossEnergyContentPerUnitVolume, gsoap_eml2_3::eml23__EnergyPerVolumeUom)
        GETTER_AND_SETTER_FLUID_CATALOG_COMPONENT_MEASURE_ATTRIBUTE(NaturalGas, NetEnergyContentPerUnitVolume, gsoap_eml2_3::eml23__EnergyPerVolumeUom)

        DLL_IMPORT_OR_EXPORT unsigned int getPseudoFluidComponentCount() const;

        DLL_IMPORT_OR_EXPORT void pushBackPseudoFluidComponent(const std::string & uid, gsoap_eml2_3::prodml22__PseudoComponentKind kind);
        GETTER_AND_SETTER_FLUID_CATALOG_COMPONENT_COMMON_ATTRIBUTES(PseudoFluidComponent)
        GETTER_AND_SETTER_FLUID_CATALOG_COMPONENT_OPTIONAL_ATTRIBUTE(PseudoFluidComponent, SpecificGravity, double)
        GETTER_AND_SETTER_FLUID_CATALOG_COMPONENT_OPTIONAL_ATTRIBUTE(PseudoFluidComponent, StartingCarbonNumber, int64_t)
        GETTER_AND_SETTER_FLUID_CATALOG_COMPONENT_OPTIONAL_ATTRIBUTE(PseudoFluidComponent, EndingCarbonNumber, int64_t)
        GETTER_AND_SETTER_FLUID_CATALOG_COMPONENT_MEASURE_ATTRIBUTE(PseudoFluidComponent, StartingBoilingPoint, gsoap_eml2_3::eml23__ThermodynamicTemperatureUom)
        GETTER_AND_SETTER_FLUID_CATALOG_COMPONENT_MEASURE_ATTRIBUTE(PseudoFluidComponent, EndingBoilingPoint, gsoap_eml2_3::eml23__ThermodynamicTemperatureUom)
        GETTER_AND_SETTER_FLUID_CATALOG_COMPONENT_MEASURE_ATTRIBUTE(PseudoFluidComponent, AvgBoilingPoint, gsoap_eml2_3::eml23__ThermodynamicTemperatureUom)
        GETTER_AND_SETTER_FLUID_CATALOG_COMPONENT_MEASURE_ATTRIBUTE(PseudoFluidComponent, AvgDensity, std::string)
        GETTER_AND_SETTER_FLUID_CATALOG_COMPONENT_MEASURE_ATTRIBUTE(PseudoFluidComponent, AvgMolecularWeight, gsoap_eml2_3::eml23__MolecularWeightUom)

        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
        };

        DLL_IMPORT_OR_EXPORT unsigned int getModelCount() const;

        DLL_IMPORT_OR_EXPORT void pushBackModel(const std::string & uid = "");

        DLL_IMPORT_OR_EXPORT PvtSpecification* getModelSpecification(unsigned int modelIndex) { return modelSpecifications[modelIndex]; }

        DLL_IMPORT_OR_EXPORT PvtSpecification* initModelSpecification(unsigned int modelIndex, ModelSpecification kind);
 
        GETTER_SETTER_OPTIONAL_ATTRIBUTE_IN_VECTOR(gsoap_eml2_3::prodml22__FluidCharacterization, gsoapProxy2_3, Model, Name, std::string)
        GETTER_SETTER_OPTIONAL_ATTRIBUTE_IN_VECTOR(gsoap_eml2_3::prodml22__FluidCharacterization, gsoapProxy2_3, Model, Remark, std::string)
        GETTER_SETTER_MEASURE_OPTIONAL_ATTRIBUTE_IN_VECTOR(gsoap_eml2_3::prodml22__FluidCharacterization, gsoapProxy2_3, Model, ReferenceTemperature, gsoap_eml2_3::eml23__ThermodynamicTemperatureUom)
        GETTER_SETTER_MEASURE_OPTIONAL_ATTRIBUTE_IN_VECTOR(gsoap_eml2_3::prodml22__FluidCharacterization, gsoapProxy2_3, Model, ReferenceStockTankTemperature, gsoap_eml2_3::eml23__ThermodynamicTemperatureUom)
 
        
        DLL_IMPORT_OR_EXPORT unsigned int getTableFormatCount() const;

        DLL_IMPORT_OR_EXPORT void pushBackTableFormat(const std::string & uid = "");

        DLL_IMPORT_OR_EXPORT uint64_t getTableFormatColumnCount(const std::string & tableFormatUid) const;

        DLL_IMPORT_OR_EXPORT std::string getTableFormatColumnUom(const std::string & tableFormatUid, unsigned int columnIndex) const;

        DLL_IMPORT_OR_EXPORT std::string getTableFormatColumnProperty(const std::string & tableFormatUid, unsigned int columnIndex) const;

        DLL_IMPORT_OR_EXPORT void pushBackTableFormatColumn(unsigned int tableFormatIndex, gsoap_eml2_3::eml23__UnitOfMeasure uom, gsoap_eml2_3::prodml22__OutputFluidProperty fluidProperty);

        DLL_IMPORT_OR_EXPORT void pushBackTableFormatColumn(unsigned int tableFormatIndex, const std::string & uom, const std::string & fluidProperty);

        DLL_IMPORT_OR_EXPORT unsigned int getTableCount(unsigned int modelIndex) const;

        DLL_IMPORT_OR_EXPORT std::string getTableName(unsigned int modelIndex, unsigned int tableIndex) const;

        DLL_IMPORT_OR_EXPORT std::string getTableFormatUid(unsigned int modelIndex, unsigned int tableIndex) const;

        DLL_IMPORT_OR_EXPORT void pushBackTable(unsigned int modelIndex, const std::string & name, const std::string & tableFormatUid, const std::string & uid = "");

        DLL_IMPORT_OR_EXPORT unsigned int getTableRowCount(unsigned int modelIndex, unsigned int tableIndex) const;

        DLL_IMPORT_OR_EXPORT std::string getTableRowContent(unsigned int modelIndex, unsigned int tableIndex, unsigned int rowIndex) const;

        DLL_IMPORT_OR_EXPORT void pushBackTableRow(unsigned int modelIndex, unsigned int tableIndex, const std::vector<double> & rowContent);

        DLL_IMPORT_OR_EXPORT void pushBackTableRow(unsigned int modelIndex, unsigned int tableIndex, const std::vector<double> & rowContent, bool isSaturated);

        DLL_IMPORT_OR_EXPORT void pushBackParameter(unsigned int modelIndex, double value, gsoap_eml2_3::eml23__UnitOfMeasure uom, gsoap_eml2_3::prodml22__OutputFluidProperty fluidProperty);

        DLL_IMPORT_OR_EXPORT void pushBackParameter(unsigned int modelIndex, double value, gsoap_eml2_3::eml23__UnitOfMeasure uom, gsoap_eml2_3::prodml22__OutputFluidProperty fluidProperty, gsoap_eml2_3::prodml22__ThermodynamicPhase phase);

        DLL_IMPORT_OR_EXPORT static constexpr char const* XML_TAG = "FluidCharacterization";

        DLL_IMPORT_OR_EXPORT virtual std::string getXmlTag() const final { return XML_TAG; }

        DLL_IMPORT_OR_EXPORT static constexpr char const* XML_NS = "prodml22";

        DLL_IMPORT_OR_EXPORT std::string getXmlNamespace() const final { return XML_NS; }

        void loadTargetRelationships() final;
 
    private:
        std::vector<PvtSpecification*> modelSpecifications;
    };
}