OPGEE Processes

This module contains the subclasses of Process defined in the opgee package.

Guidelines for documenting Process subclasses

The following elements of each process should be defined in the class header comment:

• Attributes defined for the class (no need to duplicate generic Process attributes)

• Required input and output streams, by stream type

• Optional input and output streams, by stream type (i.e., those that will be processed if present)

• Whether the process has special handling to exit the run() method unless all required input streams have data. [If we explicitly declare required stream types, we can handle this check with a common function used by all such processes.]

  • More generally, any conditions that cause the process to return without writing to output streams.

• Any data stored in, or accessed from the Field class.

• Whether the process defines an impute() method for use in initialization from exogenous data.

Process subclasses

• AcidGasRemoval Process
• BitumenMining Process
• CO2InjectionWell Process
• CO2Membrane Process
• CO2ReinjectionCompressor Process
• CrudeOilDewatering Process
• CrudeOilStabilization Process
• CrudeOilStorage Process
• CrudeOilTransport Process
• Demethanizer Process
• DownholePump Process
• Drilling Process
• Flaring Process
• GasDehydration Process
• GasDistribution Process
• GasGathering Process
• GasLiftingCompressor Process
• GasPartition Process
• GasReinjectionCompressor Process
• GasReinjectionWell Process
• HeavyOilDilution Process
• HeavyOilUpgrading Process
• LNGLiquefaction Process
• LNGRegasification Process
• LNGTransport Process
• NGL Process
• PetrocokeTransport Process
• PostStorageCompressor Process
• PreMembraneChiller Process
• PreMembraneCompressor Process
• ReservoirWellInterface Process
• RyanHolmes Process
• Separation Process
• SourGasCompressor Process
• SourGasInjection Process
• SteamGeneration Process
• StorageCompressor Process
• StorageSeparator Process
• StorageWell Process
• TransmissionCompressor Process
• VFPartition Process
• VRUCompressor Process
• Venting Process
• WaterInjection Process
• WaterTreatment Process
• Exploration Process