Opm::OutputCompositionalModule< TypeTag > Class Template Reference

Output module for compositional-model results written in ECL binary format. More...

#include <OutputCompositionalModule.hpp>

Inheritance diagram for Opm::OutputCompositionalModule< TypeTag >:

Public Member Functions
template<class CollectDataToIORankType >
	OutputCompositionalModule (const Simulator &simulator, const SummaryConfig &smryCfg, const CollectDataToIORankType &collectToIORank)
void	allocBuffers (const unsigned bufferSize, const unsigned reportStepNum, const bool substep, const bool log, const bool isRestart)
	Allocate memory for the scalar fields we would like to write to ECL output files. More...
void	assignToSolution (data::Solution &sol) override
	Move all buffers to data::Solution. More...
void	outputFipAndResvLog (const Inplace &inplace, const std::size_t reportStepNum, double elapsed, boost::posix_time::ptime currentDate, const bool substep, const Parallel::Communication &comm)
void	outputFipAndResvLogToCSV (const std::size_t reportStepNum, const bool substep, const Parallel::Communication &comm)
void	setupExtractors (const bool, const std::size_t)
	Setup list of active element-level data extractors. More...
void	clearExtractors ()
	Clear list of active element-level data extractors. More...
void	processElement (const ElementContext &elemCtx)
	Modify the internal buffers according to the intensive quanties relevant for an element. More...
void	processElementFlows (const ElementContext &)
void	processElementBlockData (const ElementContext &)
template<class ActiveIndex , class CartesianIndex >
void	processFluxes (const ElementContext &, ActiveIndex &&, CartesianIndex &&)
	Capture connection fluxes, particularly to account for inter-region flows. More...
void	initializeFluxData ()
	Prepare for capturing connection fluxes, particularly to account for inter-region flows. More...
void	finalizeFluxData ()
	Finalize capturing connection fluxes. More...
const InterRegFlowMap &	getInterRegFlows () const
	Get read-only access to collection of inter-region flows. More...
void	updateFluidInPlace (const unsigned, const IntensiveQuantities &, const double)
void	outputTimeStamp (const std::string &lbl, double elapsed, int rstep, boost::posix_time::ptime currentDate)
void	prepareDensityAccumulation ()
void	accumulateDensityParallel ()
void	outputCumLog (std::size_t reportStepNum, const bool connData)
void	outputProdLog (std::size_t reportStepNum, const bool connData)
void	outputInjLog (std::size_t reportStepNum, const bool connData)
void	outputMSWLog (std::size_t reportStepNum)
void	calc_initial_inplace (const Parallel::Communication &comm)
Inplace	calc_inplace (std::map< std::string, double > &miscSummaryData, std::map< std::string, std::vector< double > > &regionData, const Parallel::Communication &comm)
void	outputWellspecReport (const std::vector< std::string > &changedWells, const bool changedWellLists, const std::size_t reportStepNum, const double elapsed, boost::posix_time::ptime currentDate) const
void	outputErrorLog (const Parallel::Communication &comm) const
void	addRftDataToWells (data::Wells &wellDatas, std::size_t reportStepNum, const Parallel::Communication &comm)
virtual void	setRestart (const data::Solution &sol, unsigned elemIdx, unsigned globalDofIndex)
Scalar	getSolventSaturation (unsigned elemIdx) const
Scalar	getSolventRsw (unsigned elemIdx) const
Scalar	getPolymerConcentration (unsigned elemIdx) const
Scalar	getFoamConcentration (unsigned elemIdx) const
Scalar	getSaltConcentration (unsigned elemIdx) const
Scalar	getSaltSaturation (unsigned elemIdx) const
Scalar	getPermFactor (unsigned elemIdx) const
const std::vector< Scalar > &	getFluidPressure () const
const BioeffectsContainer< Scalar > &	getBioeffects () const
const CO2H2Container< Scalar > &	getCO2H2 () const
const FlowsContainer< GetPropType< TypeTag, Properties::FluidSystem > > &	getFlows () const
bool	needInterfaceFluxes (const bool isSubStep) const
const std::map< std::pair< std::string, int >, double > &	getBlockData ()
std::map< std::pair< std::string, int >, double > &	getExtraBlockData ()
const std::map< std::tuple< std::string, int, int >, double > &	getLgrBlockData () const
const Inplace *	initialInplace () const
bool	localDataValid () const
void	invalidateLocalData ()
void	validateLocalData ()
void	serializeOp (Serializer &serializer)
RSTConv &	getConv ()
const RSTConv &	getConv () const
void	assignGlobalFieldsToSolution (data::Solution &sol)
	Assign fields that are in global numbering to the solution. \detail This is used to add fields that for some reason cannot be collected using the regular collect mechanism to the solution. In particular this is used with RPTRST CONV output. More...

Static Public Member Functions
static void	registerParameters ()

Protected Types
enum
enum
enum
enum
enum
using	StringBuffer = std::vector< std::string >
using	Dir = FaceDir::DirEnum

Protected Member Functions
void	allocFormulationBuffers (std::map< std::string, int > &rstKeywords, const unsigned bufferSize) override
	Allocate compositional relative-permeability buffers. More...
void	assignPhaseProperties (data::Solution &sol, const PhasePropertyNames &names)
	Move the phase density and viscosity buffers to sol under names. More...
void	assignBuffer (data::Solution &sol, std::string_view name, UnitSystem::measure measure, std::vector< Scalar > &buffer)
void	assignBuffer (data::Solution &sol, std::string_view name, UnitSystem::measure measure, std::vector< Scalar > &buffer, int index)
	A negative index marks an inactive phase and reports nothing. More...
void	doAllocBuffers (unsigned bufferSize, unsigned reportStepNum, const bool substep, const bool log, const bool isRestart, const EclHysteresisConfig *hysteresisConfig, unsigned numOutputNnc=0, std::map< std::string, int > rstKeywords={})
void	makeRegionSum (Inplace &inplace, const std::string &region_name, const Parallel::Communication &comm) const
Inplace	accumulateRegionSums (const Parallel::Communication &comm)
void	updateSummaryRegionValues (const Inplace &inplace, std::map< std::string, double > &miscSummaryData, std::map< std::string, std::vector< double > > &regionData) const
void	setupBlockData (std::function< bool(int)> isCartIdxOnThisRank)
void	setupExtraBlockData (const std::size_t reportStepNum, std::function< bool(int)> isCartIdxOnThisRank)
void	setupLgrBlockData (const std::map< std::string, int > &lgrNameToLevel, const std::function< bool(int, int)> &isLgrCellOnThisRank)

Static Protected Member Functions
static bool	allocBufferIfRequested (std::map< std::string, int > &rstKeywords, unsigned bufferSize, std::vector< Scalar > &buffer, std::string_view kw, bool supported, bool required=false)
static bool	isOutputCreationDirective_ (const std::string &keyword)
static ScalarBuffer	regionSum (const ScalarBuffer &property, const std::vector< int > &regionId, const std::size_t maxNumberOfRegions, const Parallel::Communication &comm)
static int	regionMax (const std::vector< int > &region, const Parallel::Communication &comm)
static void	update (Inplace &inplace, const std::string &region_name, const Inplace::Phase phase, const std::size_t ntFip, const ScalarBuffer &values)
static Scalar	sum (const ScalarBuffer &v)

Protected Attributes
const EclipseState &	eclState_
const Schedule &	schedule_
const SummaryState &	summaryState_
SummaryConfig	summaryConfig_
InterRegFlowMap	interRegionFlows_
LogOutputHelper< Scalar >	logOutput_
bool	enableEnergy_
bool	constantTemperature_
bool	enableMech_
bool	enableSolvent_
bool	enablePolymer_
bool	enableFoam_
bool	enableBrine_
bool	enableSaltPrecipitation_
bool	enableExtbo_
bool	enableBioeffects_
bool	enableGeochemistry_
bool	forceDisableFipOutput_
bool	forceDisableFipresvOutput_
bool	computeFip_
FIPContainer< GetPropType< TypeTag, Properties::FluidSystem > >	fipC_
std::unordered_map< std::string, std::vector< int > >	regions_
std::unordered_map< Inplace::Phase, std::vector< SummaryConfigNode > >	regionNodes_
std::vector< SummaryConfigNode >	RPRNodes_
std::vector< SummaryConfigNode >	RPRPNodes_
std::vector< int >	failedCellsPb_
std::vector< int >	failedCellsPd_
ScalarBuffer	gasFormationVolumeFactor_
ScalarBuffer	hydrocarbonPoreVolume_
ScalarBuffer	pressureTimesPoreVolume_
ScalarBuffer	pressureTimesHydrocarbonVolume_
ScalarBuffer	rPorV_
ScalarBuffer	fluidPressure_
ScalarBuffer	temperature_
ScalarBuffer	rsw_
ScalarBuffer	rvw_
ScalarBuffer	overburdenPressure_
ScalarBuffer	oilSaturationPressure_
ScalarBuffer	drsdtcon_
ScalarBuffer	sSol_
ScalarBuffer	rswSol_
ScalarBuffer	cPolymer_
ScalarBuffer	cFoam_
ScalarBuffer	cSalt_
ScalarBuffer	pSalt_
ScalarBuffer	permFact_
ExtboContainer< Scalar >	extboC_
ScalarBuffer	soMax_
ScalarBuffer	swMax_
ScalarBuffer	sgmax_
ScalarBuffer	shmax_
ScalarBuffer	somin_
ScalarBuffer	swmin_
ScalarBuffer	ppcw_
ScalarBuffer	gasDissolutionFactor_
ScalarBuffer	oilVaporizationFactor_
ScalarBuffer	gasDissolutionFactorInWater_
ScalarBuffer	waterVaporizationFactor_
ScalarBuffer	rockCompPorvMultiplier_
ScalarBuffer	minimumOilPressure_
ScalarBuffer	saturatedOilFormationVolumeFactor_
ScalarBuffer	rockCompTransMultiplier_
BioeffectsContainer< Scalar >	bioeffectsC_
CO2H2Container< Scalar >	CO2H2C_
ScalarBuffer	pcgw_
ScalarBuffer	pcow_
ScalarBuffer	pcog_
MechContainer< Scalar >	mech_
TpsaContainer< Scalar >	tpsaC_
std::array< ScalarBuffer, numPhases >	saturation_
std::array< ScalarBuffer, numPhases >	density_
std::array< ScalarBuffer, numPhases >	viscosity_
GeochemistryContainer< Scalar >	geochemC_
TracerContainer< GetPropType< TypeTag, Properties::FluidSystem > >	tracerC_
std::array< ScalarBuffer, numPhases >	residual_
FlowsContainer< GetPropType< TypeTag, Properties::FluidSystem > >	flowsC_
RFTContainer< GetPropType< TypeTag, Properties::FluidSystem > >	rftC_
RSTConv	rst_conv_
	Helper class for RPTRST CONV. More...
std::map< std::pair< std::string, int >, double >	blockData_
std::map< std::pair< std::string, int >, double >	extraBlockData_
std::map< std::tuple< std::string, int, int >, double >	lgrBlockData_
std::optional< Inplace >	initialInplace_
bool	local_data_valid_
std::optional< RegionPhasePoreVolAverage >	regionAvgDensity_

Detailed Description

template<class TypeTag>
class Opm::OutputCompositionalModule< TypeTag >

Output module for compositional-model results written in ECL binary format.

Member Typedef Documentation

Dir

using Opm::GenericOutputModule< GetPropType< TypeTag, Properties::FluidSystem > >::Dir = FaceDir::DirEnum

protectedinherited

StringBuffer

using Opm::GenericOutputModule< GetPropType< TypeTag, Properties::FluidSystem > >::StringBuffer = std::vector<std::string>

protectedinherited

Member Enumeration Documentation

anonymous enum

anonymous enum

protectedinherited

anonymous enum

anonymous enum

protectedinherited

anonymous enum

anonymous enum

protectedinherited

anonymous enum

anonymous enum

protectedinherited

anonymous enum

anonymous enum

protectedinherited

Constructor & Destructor Documentation

OutputCompositionalModule()

template<class TypeTag >

template<class CollectDataToIORankType >

Opm::OutputCompositionalModule< TypeTag >::OutputCompositionalModule ( const Simulator &  simulator, const SummaryConfig &  smryCfg, const CollectDataToIORankType &  collectToIORank  )

inline

Member Function Documentation

accumulateDensityParallel()

void Opm::GenericOutputModule< GetPropType< TypeTag, Properties::FluidSystem > >::accumulateDensityParallel ( )

inherited

Run cross-rank parallel accumulation of per-region phase density running sums (average values).

accumulateRegionSums()

Inplace Opm::GenericOutputModule< GetPropType< TypeTag, Properties::FluidSystem > >::accumulateRegionSums ( const Parallel::Communication &  comm )

protectedinherited

addRftDataToWells()

void Opm::GenericOutputModule< GetPropType< TypeTag, Properties::FluidSystem > >::addRftDataToWells ( data::Wells &  wellDatas, std::size_t  reportStepNum, const Parallel::Communication &  comm  )

inlineinherited

allocBufferIfRequested()

static bool Opm::GenericOutputModule< GetPropType< TypeTag, Properties::FluidSystem > >::allocBufferIfRequested ( std::map< std::string, int > &  rstKeywords, unsigned  bufferSize, std::vector< Scalar > &  buffer, std::string_view  kw, bool  supported, bool  required = false  )

staticprotectedinherited

Resize buffer when the restart keyword kw is requested, and mark the request as handled.

allocBuffers()

template<class TypeTag >

void Opm::OutputCompositionalModule< TypeTag >::allocBuffers ( const unsigned  bufferSize, const unsigned  reportStepNum, const bool  substep, const bool  log, const bool  isRestart  )

inline

Allocate memory for the scalar fields we would like to write to ECL output files.

References Opm::GenericOutputModule< GetPropType< TypeTag, Properties::FluidSystem > >::doAllocBuffers(), and Opm::GenericOutputModule< GetPropType< TypeTag, Properties::FluidSystem > >::schedule_.

allocFormulationBuffers()

template<class TypeTag >

void Opm::OutputCompositionalModule< TypeTag >::allocFormulationBuffers ( std::map< std::string, int > &  rstKeywords, const unsigned  bufferSize  )

inlineoverrideprotectedvirtual

Allocate compositional relative-permeability buffers.

Implements Opm::GenericOutputModule< GetPropType< TypeTag, Properties::FluidSystem > >.

assignBuffer() [1/2]

void Opm::GenericOutputModule< GetPropType< TypeTag, Properties::FluidSystem > >::assignBuffer ( data::Solution &  sol, std::string_view  name, UnitSystem::measure  measure, std::vector< Scalar > &  buffer  )

protectedinherited

Move a single buffer to sol. An unallocated buffer has nothing to report.

assignBuffer() [2/2]

void Opm::GenericOutputModule< GetPropType< TypeTag, Properties::FluidSystem > >::assignBuffer ( data::Solution &  sol, std::string_view  name, UnitSystem::measure  measure, std::vector< Scalar > &  buffer, int  index  )

protectedinherited

A negative index marks an inactive phase and reports nothing.

assignGlobalFieldsToSolution()

void Opm::GenericOutputModule< GetPropType< TypeTag, Properties::FluidSystem > >::assignGlobalFieldsToSolution ( data::Solution &  sol )

inherited

Assign fields that are in global numbering to the solution. \detail This is used to add fields that for some reason cannot be collected using the regular collect mechanism to the solution. In particular this is used with RPTRST CONV output.

assignPhaseProperties()

void Opm::GenericOutputModule< GetPropType< TypeTag, Properties::FluidSystem > >::assignPhaseProperties ( data::Solution &  sol, const PhasePropertyNames &  names  )

protectedinherited

Move the phase density and viscosity buffers to sol under names.

assignToSolution()

template<class TypeTag >

void Opm::OutputCompositionalModule< TypeTag >::assignToSolution ( data::Solution &  sol )

inlineoverridevirtual

Move all buffers to data::Solution.

Reimplemented from Opm::GenericOutputModule< GetPropType< TypeTag, Properties::FluidSystem > >.

References Opm::GenericOutputModule< GetPropType< TypeTag, Properties::FluidSystem > >::assignBuffer(), Opm::GenericOutputModule< GetPropType< TypeTag, Properties::FluidSystem > >::assignPhaseProperties(), Opm::GenericOutputModule< FluidSystem >::assignToSolution(), Opm::GenericOutputModule< FluidSystem >::PhasePropertyNames::oilDensity, and Opm::GenericOutputModule< GetPropType< TypeTag, Properties::FluidSystem > >::saturation_.

calc_initial_inplace()

void Opm::GenericOutputModule< GetPropType< TypeTag, Properties::FluidSystem > >::calc_initial_inplace ( const Parallel::Communication &  comm )

inherited

calc_inplace()

Inplace Opm::GenericOutputModule< GetPropType< TypeTag, Properties::FluidSystem > >::calc_inplace ( std::map< std::string, double > &  miscSummaryData, std::map< std::string, std::vector< double > > &  regionData, const Parallel::Communication &  comm  )

inherited

clearExtractors()

template<class TypeTag >

void Opm::OutputCompositionalModule< TypeTag >::clearExtractors ( )

inline

Clear list of active element-level data extractors.

doAllocBuffers()

void Opm::GenericOutputModule< GetPropType< TypeTag, Properties::FluidSystem > >::doAllocBuffers ( unsigned  bufferSize, unsigned  reportStepNum, const bool  substep, const bool  log, const bool  isRestart, const EclHysteresisConfig *  hysteresisConfig, unsigned  numOutputNnc = 0, std::map< std::string, int >  rstKeywords = {}  )

protectedinherited

finalizeFluxData()

template<class TypeTag >

void Opm::OutputCompositionalModule< TypeTag >::finalizeFluxData ( )

inline

Finalize capturing connection fluxes.

getBioeffects()

const BioeffectsContainer< Scalar > & Opm::GenericOutputModule< GetPropType< TypeTag, Properties::FluidSystem > >::getBioeffects ( ) const

inlineinherited

getBlockData()

const std::map< std::pair< std::string, int >, double > & Opm::GenericOutputModule< GetPropType< TypeTag, Properties::FluidSystem > >::getBlockData ( )

inlineinherited

getCO2H2()

const CO2H2Container< Scalar > & Opm::GenericOutputModule< GetPropType< TypeTag, Properties::FluidSystem > >::getCO2H2 ( ) const

inlineinherited

getConv() [1/2]

RSTConv & Opm::GenericOutputModule< GetPropType< TypeTag, Properties::FluidSystem > >::getConv ( )

inlineinherited

getConv() [2/2]

const RSTConv & Opm::GenericOutputModule< GetPropType< TypeTag, Properties::FluidSystem > >::getConv ( ) const

inlineinherited

getExtraBlockData()

std::map< std::pair< std::string, int >, double > & Opm::GenericOutputModule< GetPropType< TypeTag, Properties::FluidSystem > >::getExtraBlockData ( )

inlineinherited

getFlows()

const FlowsContainer< GetPropType< TypeTag, Properties::FluidSystem > > & Opm::GenericOutputModule< GetPropType< TypeTag, Properties::FluidSystem > >::getFlows ( ) const

inlineinherited

getFluidPressure()

const std::vector< Scalar > & Opm::GenericOutputModule< GetPropType< TypeTag, Properties::FluidSystem > >::getFluidPressure ( ) const

inlineinherited

getFoamConcentration()

Scalar Opm::GenericOutputModule< GetPropType< TypeTag, Properties::FluidSystem > >::getFoamConcentration ( unsigned  elemIdx ) const

inlineinherited

getInterRegFlows()

template<class TypeTag >

const InterRegFlowMap & Opm::OutputCompositionalModule< TypeTag >::getInterRegFlows ( ) const

inline

Get read-only access to collection of inter-region flows.

getLgrBlockData()

const std::map< std::tuple< std::string, int, int >, double > & Opm::GenericOutputModule< GetPropType< TypeTag, Properties::FluidSystem > >::getLgrBlockData ( ) const

inlineinherited

getPermFactor()

Scalar Opm::GenericOutputModule< GetPropType< TypeTag, Properties::FluidSystem > >::getPermFactor ( unsigned  elemIdx ) const

inlineinherited

getPolymerConcentration()

Scalar Opm::GenericOutputModule< GetPropType< TypeTag, Properties::FluidSystem > >::getPolymerConcentration ( unsigned  elemIdx ) const

inlineinherited

getSaltConcentration()

Scalar Opm::GenericOutputModule< GetPropType< TypeTag, Properties::FluidSystem > >::getSaltConcentration ( unsigned  elemIdx ) const

inlineinherited

getSaltSaturation()

Scalar Opm::GenericOutputModule< GetPropType< TypeTag, Properties::FluidSystem > >::getSaltSaturation ( unsigned  elemIdx ) const

inlineinherited

getSolventRsw()

Scalar Opm::GenericOutputModule< GetPropType< TypeTag, Properties::FluidSystem > >::getSolventRsw ( unsigned  elemIdx ) const

inlineinherited

getSolventSaturation()

Scalar Opm::GenericOutputModule< GetPropType< TypeTag, Properties::FluidSystem > >::getSolventSaturation ( unsigned  elemIdx ) const

inlineinherited

initialInplace()

const Inplace * Opm::GenericOutputModule< GetPropType< TypeTag, Properties::FluidSystem > >::initialInplace ( ) const

inlineinherited

initializeFluxData()

template<class TypeTag >

void Opm::OutputCompositionalModule< TypeTag >::initializeFluxData ( )

inline

Prepare for capturing connection fluxes, particularly to account for inter-region flows.

invalidateLocalData()

void Opm::GenericOutputModule< GetPropType< TypeTag, Properties::FluidSystem > >::invalidateLocalData ( )

inlineinherited

isOutputCreationDirective_()

static bool Opm::GenericOutputModule< GetPropType< TypeTag, Properties::FluidSystem > >::isOutputCreationDirective_ ( const std::string &  keyword )

staticprotectedinherited

localDataValid()

bool Opm::GenericOutputModule< GetPropType< TypeTag, Properties::FluidSystem > >::localDataValid ( ) const

inlineinherited

makeRegionSum()

void Opm::GenericOutputModule< GetPropType< TypeTag, Properties::FluidSystem > >::makeRegionSum ( Inplace &  inplace, const std::string &  region_name, const Parallel::Communication &  comm  ) const

protectedinherited

needInterfaceFluxes()

bool Opm::GenericOutputModule< GetPropType< TypeTag, Properties::FluidSystem > >::needInterfaceFluxes ( const bool  isSubStep ) const

inlineinherited

outputCumLog()

void Opm::GenericOutputModule< GetPropType< TypeTag, Properties::FluidSystem > >::outputCumLog ( std::size_t  reportStepNum, const bool  connData  )

inherited

outputErrorLog()

void Opm::GenericOutputModule< GetPropType< TypeTag, Properties::FluidSystem > >::outputErrorLog ( const Parallel::Communication &  comm ) const

inherited

outputFipAndResvLog()

template<class TypeTag >

void Opm::OutputCompositionalModule< TypeTag >::outputFipAndResvLog ( const Inplace &  inplace, const std::size_t  reportStepNum, double  elapsed, boost::posix_time::ptime  currentDate, const bool  substep, const Parallel::Communication &  comm  )

inline

References Opm::GenericOutputModule< GetPropType< TypeTag, Properties::FluidSystem > >::eclState_, Opm::GenericOutputModule< GetPropType< TypeTag, Properties::FluidSystem > >::forceDisableFipOutput_, Opm::GenericOutputModule< GetPropType< TypeTag, Properties::FluidSystem > >::initialInplace(), Opm::GenericOutputModule< GetPropType< TypeTag, Properties::FluidSystem > >::logOutput_, and Opm::GenericOutputModule< GetPropType< TypeTag, Properties::FluidSystem > >::schedule_.

outputFipAndResvLogToCSV()

template<class TypeTag >

void Opm::OutputCompositionalModule< TypeTag >::outputFipAndResvLogToCSV ( const std::size_t  reportStepNum, const bool  substep, const Parallel::Communication &  comm  )

inline

References Opm::GenericOutputModule< GetPropType< TypeTag, Properties::FluidSystem > >::eclState_, Opm::GenericOutputModule< GetPropType< TypeTag, Properties::FluidSystem > >::initialInplace(), Opm::GenericOutputModule< GetPropType< TypeTag, Properties::FluidSystem > >::logOutput_, and Opm::GenericOutputModule< GetPropType< TypeTag, Properties::FluidSystem > >::schedule_.

outputInjLog()

void Opm::GenericOutputModule< GetPropType< TypeTag, Properties::FluidSystem > >::outputInjLog ( std::size_t  reportStepNum, const bool  connData  )

inherited

outputMSWLog()

void Opm::GenericOutputModule< GetPropType< TypeTag, Properties::FluidSystem > >::outputMSWLog ( std::size_t  reportStepNum )

inherited

outputProdLog()

void Opm::GenericOutputModule< GetPropType< TypeTag, Properties::FluidSystem > >::outputProdLog ( std::size_t  reportStepNum, const bool  connData  )

inherited

outputTimeStamp()

void Opm::GenericOutputModule< GetPropType< TypeTag, Properties::FluidSystem > >::outputTimeStamp ( const std::string &  lbl, double  elapsed, int  rstep, boost::posix_time::ptime  currentDate  )

inherited

outputWellspecReport()

void Opm::GenericOutputModule< GetPropType< TypeTag, Properties::FluidSystem > >::outputWellspecReport ( const std::vector< std::string > &  changedWells, const bool  changedWellLists, const std::size_t  reportStepNum, const double  elapsed, boost::posix_time::ptime  currentDate  ) const

inherited

Emit well specification report

Includes well level, connection level, and segment level information for structurally changed wells. Also includes contents of well lists for structurally changed well lists.

Parameters

[in]	changedWells	Wells whose structures differ from those of the previous well specification report.
[in]	changedWellLists	Whether or not any of the run's current well lists changed structurally since the previous well specification report.
[in]	reportStepNum	One-based report step index.
[in]	elapsed	Simulated time, in seconds, since start of simulation run.
[in]	currentDate	Time point at which this well specification report is emitted.

prepareDensityAccumulation()

void Opm::GenericOutputModule< GetPropType< TypeTag, Properties::FluidSystem > >::prepareDensityAccumulation ( )

inherited

Clear internal arrays for parallel accumulation of per-region phase density averages.

processElement()

template<class TypeTag >

void Opm::OutputCompositionalModule< TypeTag >::processElement ( const ElementContext &  elemCtx )

inline

Modify the internal buffers according to the intensive quanties relevant for an element.

References Opm::detail::Extractor< TypeTag >::Context::episodeIndex.

processElementBlockData()

template<class TypeTag >

void Opm::OutputCompositionalModule< TypeTag >::processElementBlockData ( const ElementContext &  )

inline

processElementFlows()

template<class TypeTag >

void Opm::OutputCompositionalModule< TypeTag >::processElementFlows ( const ElementContext &  )

inline

processFluxes()

template<class TypeTag >

template<class ActiveIndex , class CartesianIndex >

void Opm::OutputCompositionalModule< TypeTag >::processFluxes ( const ElementContext &  , ActiveIndex &&  , CartesianIndex &&    )

inline

Capture connection fluxes, particularly to account for inter-region flows.

Template Parameters

ActiveIndex	Callable type, typically a lambda, that enables retrieving the active index, on the local MPI rank, of a particular cell/element. Must support a function call operator of the form int operator()(const Element& elem) const
CartesianIndex	Callable type, typically a lambda, that enables retrieving the globally unique Cartesian index of a particular cell/element given its active index on the local MPI rank. Must support a function call operator of the form int operator()(const int activeIndex) const

Parameters

[in]	elemCtx	Primary lookup structure for per-cell/element dynamic information.
[in]	activeIndex	Mapping from cell/elements to linear indices on local MPI rank.
[in]	cartesianIndex	Mapping from active index on local MPI rank to globally unique Cartesian cell/element index.

regionMax()

static int Opm::GenericOutputModule< GetPropType< TypeTag, Properties::FluidSystem > >::regionMax ( const std::vector< int > &  region, const Parallel::Communication &  comm  )

staticprotectedinherited

regionSum()

static ScalarBuffer Opm::GenericOutputModule< GetPropType< TypeTag, Properties::FluidSystem > >::regionSum ( const ScalarBuffer &  property, const std::vector< int > &  regionId, const std::size_t  maxNumberOfRegions, const Parallel::Communication &  comm  )

staticprotectedinherited

registerParameters()

template<class TypeTag >

static void Opm::OutputCompositionalModule< TypeTag >::registerParameters ( )

inlinestatic

References Opm::VtkBlackoilParams::registerParameters(), and Opm::GenericOutputModule< FluidSystem >::registerParameters().

serializeOp()

void Opm::GenericOutputModule< GetPropType< TypeTag, Properties::FluidSystem > >::serializeOp ( Serializer &  serializer )

inlineinherited

setRestart()

virtual void Opm::GenericOutputModule< GetPropType< TypeTag, Properties::FluidSystem > >::setRestart ( const data::Solution &  sol, unsigned  elemIdx, unsigned  globalDofIndex  )

virtualinherited

Reimplemented in Opm::OutputBlackOilModule< TypeTag >.

setupBlockData()

void Opm::GenericOutputModule< GetPropType< TypeTag, Properties::FluidSystem > >::setupBlockData ( std::function< bool(int)>  isCartIdxOnThisRank )

protectedinherited

setupExtraBlockData()

void Opm::GenericOutputModule< GetPropType< TypeTag, Properties::FluidSystem > >::setupExtraBlockData ( const std::size_t  reportStepNum, std::function< bool(int)>  isCartIdxOnThisRank  )

protectedinherited

setupExtractors()

template<class TypeTag >

void Opm::OutputCompositionalModule< TypeTag >::setupExtractors ( const bool  , const std::size_t    )

inline

Setup list of active element-level data extractors.

References Opm::GenericOutputModule< GetPropType< TypeTag, Properties::FluidSystem > >::fluidPressure_, Opm::GenericOutputModule< GetPropType< TypeTag, Properties::FluidSystem > >::saturation_, and Opm::GenericOutputModule< GetPropType< TypeTag, Properties::FluidSystem > >::temperature_.

setupLgrBlockData()

void Opm::GenericOutputModule< GetPropType< TypeTag, Properties::FluidSystem > >::setupLgrBlockData ( const std::map< std::string, int > &  lgrNameToLevel, const std::function< bool(int, int)> &  isLgrCellOnThisRank  )

protectedinherited

sum()

static Scalar Opm::GenericOutputModule< GetPropType< TypeTag, Properties::FluidSystem > >::sum ( const ScalarBuffer &  v )

staticprotectedinherited

update()

static void Opm::GenericOutputModule< GetPropType< TypeTag, Properties::FluidSystem > >::update ( Inplace &  inplace, const std::string &  region_name, const Inplace::Phase  phase, const std::size_t  ntFip, const ScalarBuffer &  values  )

staticprotectedinherited

updateFluidInPlace()

template<class TypeTag >

void Opm::OutputCompositionalModule< TypeTag >::updateFluidInPlace ( const unsigned  , const IntensiveQuantities &  , const double    )

inline

updateSummaryRegionValues()

void Opm::GenericOutputModule< GetPropType< TypeTag, Properties::FluidSystem > >::updateSummaryRegionValues ( const Inplace &  inplace, std::map< std::string, double > &  miscSummaryData, std::map< std::string, std::vector< double > > &  regionData  ) const

protectedinherited

validateLocalData()

void Opm::GenericOutputModule< GetPropType< TypeTag, Properties::FluidSystem > >::validateLocalData ( )

inlineinherited

Member Data Documentation

bioeffectsC_

BioeffectsContainer<Scalar> Opm::GenericOutputModule< GetPropType< TypeTag, Properties::FluidSystem > >::bioeffectsC_

protectedinherited

blockData_

std::map<std::pair<std::string, int>, double> Opm::GenericOutputModule< GetPropType< TypeTag, Properties::FluidSystem > >::blockData_

protectedinherited

cFoam_

ScalarBuffer Opm::GenericOutputModule< GetPropType< TypeTag, Properties::FluidSystem > >::cFoam_

protectedinherited

CO2H2C_

CO2H2Container<Scalar> Opm::GenericOutputModule< GetPropType< TypeTag, Properties::FluidSystem > >::CO2H2C_

protectedinherited

computeFip_

bool Opm::GenericOutputModule< GetPropType< TypeTag, Properties::FluidSystem > >::computeFip_

protectedinherited

constantTemperature_

bool Opm::GenericOutputModule< GetPropType< TypeTag, Properties::FluidSystem > >::constantTemperature_

protectedinherited

cPolymer_

ScalarBuffer Opm::GenericOutputModule< GetPropType< TypeTag, Properties::FluidSystem > >::cPolymer_

protectedinherited

cSalt_

ScalarBuffer Opm::GenericOutputModule< GetPropType< TypeTag, Properties::FluidSystem > >::cSalt_

protectedinherited

density_

std::array<ScalarBuffer, numPhases> Opm::GenericOutputModule< GetPropType< TypeTag, Properties::FluidSystem > >::density_

protectedinherited

drsdtcon_

ScalarBuffer Opm::GenericOutputModule< GetPropType< TypeTag, Properties::FluidSystem > >::drsdtcon_

protectedinherited

eclState_

const EclipseState& Opm::GenericOutputModule< GetPropType< TypeTag, Properties::FluidSystem > >::eclState_

protectedinherited

enableBioeffects_

bool Opm::GenericOutputModule< GetPropType< TypeTag, Properties::FluidSystem > >::enableBioeffects_

protectedinherited

enableBrine_

bool Opm::GenericOutputModule< GetPropType< TypeTag, Properties::FluidSystem > >::enableBrine_

protectedinherited

enableEnergy_

bool Opm::GenericOutputModule< GetPropType< TypeTag, Properties::FluidSystem > >::enableEnergy_

protectedinherited

enableExtbo_

bool Opm::GenericOutputModule< GetPropType< TypeTag, Properties::FluidSystem > >::enableExtbo_

protectedinherited

enableFoam_

bool Opm::GenericOutputModule< GetPropType< TypeTag, Properties::FluidSystem > >::enableFoam_

protectedinherited

enableGeochemistry_

bool Opm::GenericOutputModule< GetPropType< TypeTag, Properties::FluidSystem > >::enableGeochemistry_

protectedinherited

enableMech_

bool Opm::GenericOutputModule< GetPropType< TypeTag, Properties::FluidSystem > >::enableMech_

protectedinherited

enablePolymer_

bool Opm::GenericOutputModule< GetPropType< TypeTag, Properties::FluidSystem > >::enablePolymer_

protectedinherited

enableSaltPrecipitation_

bool Opm::GenericOutputModule< GetPropType< TypeTag, Properties::FluidSystem > >::enableSaltPrecipitation_

protectedinherited

enableSolvent_

bool Opm::GenericOutputModule< GetPropType< TypeTag, Properties::FluidSystem > >::enableSolvent_

protectedinherited

extboC_

ExtboContainer<Scalar> Opm::GenericOutputModule< GetPropType< TypeTag, Properties::FluidSystem > >::extboC_

protectedinherited

extraBlockData_

std::map<std::pair<std::string, int>, double> Opm::GenericOutputModule< GetPropType< TypeTag, Properties::FluidSystem > >::extraBlockData_

protectedinherited

failedCellsPb_

std::vector<int> Opm::GenericOutputModule< GetPropType< TypeTag, Properties::FluidSystem > >::failedCellsPb_

protectedinherited

failedCellsPd_

std::vector<int> Opm::GenericOutputModule< GetPropType< TypeTag, Properties::FluidSystem > >::failedCellsPd_

protectedinherited

fipC_

FIPContainer<GetPropType< TypeTag, Properties::FluidSystem > > Opm::GenericOutputModule< GetPropType< TypeTag, Properties::FluidSystem > >::fipC_

protectedinherited

flowsC_

FlowsContainer<GetPropType< TypeTag, Properties::FluidSystem > > Opm::GenericOutputModule< GetPropType< TypeTag, Properties::FluidSystem > >::flowsC_

protectedinherited

fluidPressure_

ScalarBuffer Opm::GenericOutputModule< GetPropType< TypeTag, Properties::FluidSystem > >::fluidPressure_

protectedinherited

forceDisableFipOutput_

bool Opm::GenericOutputModule< GetPropType< TypeTag, Properties::FluidSystem > >::forceDisableFipOutput_

protectedinherited

forceDisableFipresvOutput_

bool Opm::GenericOutputModule< GetPropType< TypeTag, Properties::FluidSystem > >::forceDisableFipresvOutput_

protectedinherited

gasDissolutionFactor_

ScalarBuffer Opm::GenericOutputModule< GetPropType< TypeTag, Properties::FluidSystem > >::gasDissolutionFactor_

protectedinherited

gasDissolutionFactorInWater_

ScalarBuffer Opm::GenericOutputModule< GetPropType< TypeTag, Properties::FluidSystem > >::gasDissolutionFactorInWater_

protectedinherited

gasFormationVolumeFactor_

ScalarBuffer Opm::GenericOutputModule< GetPropType< TypeTag, Properties::FluidSystem > >::gasFormationVolumeFactor_

protectedinherited

geochemC_

GeochemistryContainer<Scalar> Opm::GenericOutputModule< GetPropType< TypeTag, Properties::FluidSystem > >::geochemC_

protectedinherited

hydrocarbonPoreVolume_

ScalarBuffer Opm::GenericOutputModule< GetPropType< TypeTag, Properties::FluidSystem > >::hydrocarbonPoreVolume_

protectedinherited

initialInplace_

std::optional<Inplace> Opm::GenericOutputModule< GetPropType< TypeTag, Properties::FluidSystem > >::initialInplace_

protectedinherited

interRegionFlows_

InterRegFlowMap Opm::GenericOutputModule< GetPropType< TypeTag, Properties::FluidSystem > >::interRegionFlows_

protectedinherited

lgrBlockData_

std::map<std::tuple<std::string, int, int>, double> Opm::GenericOutputModule< GetPropType< TypeTag, Properties::FluidSystem > >::lgrBlockData_

protectedinherited

local_data_valid_

bool Opm::GenericOutputModule< GetPropType< TypeTag, Properties::FluidSystem > >::local_data_valid_

protectedinherited

logOutput_

LogOutputHelper<Scalar> Opm::GenericOutputModule< GetPropType< TypeTag, Properties::FluidSystem > >::logOutput_

protectedinherited

mech_

MechContainer<Scalar> Opm::GenericOutputModule< GetPropType< TypeTag, Properties::FluidSystem > >::mech_

protectedinherited

minimumOilPressure_

ScalarBuffer Opm::GenericOutputModule< GetPropType< TypeTag, Properties::FluidSystem > >::minimumOilPressure_

protectedinherited

oilSaturationPressure_

ScalarBuffer Opm::GenericOutputModule< GetPropType< TypeTag, Properties::FluidSystem > >::oilSaturationPressure_

protectedinherited

oilVaporizationFactor_

ScalarBuffer Opm::GenericOutputModule< GetPropType< TypeTag, Properties::FluidSystem > >::oilVaporizationFactor_

protectedinherited

overburdenPressure_

ScalarBuffer Opm::GenericOutputModule< GetPropType< TypeTag, Properties::FluidSystem > >::overburdenPressure_

protectedinherited

pcgw_

ScalarBuffer Opm::GenericOutputModule< GetPropType< TypeTag, Properties::FluidSystem > >::pcgw_

protectedinherited

pcog_

ScalarBuffer Opm::GenericOutputModule< GetPropType< TypeTag, Properties::FluidSystem > >::pcog_

protectedinherited

pcow_

ScalarBuffer Opm::GenericOutputModule< GetPropType< TypeTag, Properties::FluidSystem > >::pcow_

protectedinherited

permFact_

ScalarBuffer Opm::GenericOutputModule< GetPropType< TypeTag, Properties::FluidSystem > >::permFact_

protectedinherited

ppcw_

ScalarBuffer Opm::GenericOutputModule< GetPropType< TypeTag, Properties::FluidSystem > >::ppcw_

protectedinherited

pressureTimesHydrocarbonVolume_

ScalarBuffer Opm::GenericOutputModule< GetPropType< TypeTag, Properties::FluidSystem > >::pressureTimesHydrocarbonVolume_

protectedinherited

pressureTimesPoreVolume_

ScalarBuffer Opm::GenericOutputModule< GetPropType< TypeTag, Properties::FluidSystem > >::pressureTimesPoreVolume_

protectedinherited

pSalt_

ScalarBuffer Opm::GenericOutputModule< GetPropType< TypeTag, Properties::FluidSystem > >::pSalt_

protectedinherited

regionAvgDensity_

std::optional<RegionPhasePoreVolAverage> Opm::GenericOutputModule< GetPropType< TypeTag, Properties::FluidSystem > >::regionAvgDensity_

protectedinherited

regionNodes_

std::unordered_map<Inplace::Phase, std::vector<SummaryConfigNode> > Opm::GenericOutputModule< GetPropType< TypeTag, Properties::FluidSystem > >::regionNodes_

protectedinherited

regions_

std::unordered_map<std::string, std::vector<int> > Opm::GenericOutputModule< GetPropType< TypeTag, Properties::FluidSystem > >::regions_

protectedinherited

residual_

std::array<ScalarBuffer, numPhases> Opm::GenericOutputModule< GetPropType< TypeTag, Properties::FluidSystem > >::residual_

protectedinherited

rftC_

RFTContainer<GetPropType< TypeTag, Properties::FluidSystem > > Opm::GenericOutputModule< GetPropType< TypeTag, Properties::FluidSystem > >::rftC_

protectedinherited

rockCompPorvMultiplier_

ScalarBuffer Opm::GenericOutputModule< GetPropType< TypeTag, Properties::FluidSystem > >::rockCompPorvMultiplier_

protectedinherited

rockCompTransMultiplier_

ScalarBuffer Opm::GenericOutputModule< GetPropType< TypeTag, Properties::FluidSystem > >::rockCompTransMultiplier_

protectedinherited

rPorV_

ScalarBuffer Opm::GenericOutputModule< GetPropType< TypeTag, Properties::FluidSystem > >::rPorV_

protectedinherited

RPRNodes_

std::vector<SummaryConfigNode> Opm::GenericOutputModule< GetPropType< TypeTag, Properties::FluidSystem > >::RPRNodes_

protectedinherited

RPRPNodes_

std::vector<SummaryConfigNode> Opm::GenericOutputModule< GetPropType< TypeTag, Properties::FluidSystem > >::RPRPNodes_

protectedinherited

rst_conv_

RSTConv Opm::GenericOutputModule< GetPropType< TypeTag, Properties::FluidSystem > >::rst_conv_

protectedinherited

Helper class for RPTRST CONV.

rsw_

ScalarBuffer Opm::GenericOutputModule< GetPropType< TypeTag, Properties::FluidSystem > >::rsw_

protectedinherited

rswSol_

ScalarBuffer Opm::GenericOutputModule< GetPropType< TypeTag, Properties::FluidSystem > >::rswSol_

protectedinherited

rvw_

ScalarBuffer Opm::GenericOutputModule< GetPropType< TypeTag, Properties::FluidSystem > >::rvw_

protectedinherited

saturatedOilFormationVolumeFactor_

ScalarBuffer Opm::GenericOutputModule< GetPropType< TypeTag, Properties::FluidSystem > >::saturatedOilFormationVolumeFactor_

protectedinherited

saturation_

std::array<ScalarBuffer, numPhases> Opm::GenericOutputModule< GetPropType< TypeTag, Properties::FluidSystem > >::saturation_

protectedinherited

schedule_

const Schedule& Opm::GenericOutputModule< GetPropType< TypeTag, Properties::FluidSystem > >::schedule_

protectedinherited

sgmax_

ScalarBuffer Opm::GenericOutputModule< GetPropType< TypeTag, Properties::FluidSystem > >::sgmax_

protectedinherited

shmax_

ScalarBuffer Opm::GenericOutputModule< GetPropType< TypeTag, Properties::FluidSystem > >::shmax_

protectedinherited

soMax_

ScalarBuffer Opm::GenericOutputModule< GetPropType< TypeTag, Properties::FluidSystem > >::soMax_

protectedinherited

somin_

ScalarBuffer Opm::GenericOutputModule< GetPropType< TypeTag, Properties::FluidSystem > >::somin_

protectedinherited

sSol_

ScalarBuffer Opm::GenericOutputModule< GetPropType< TypeTag, Properties::FluidSystem > >::sSol_

protectedinherited

summaryConfig_

SummaryConfig Opm::GenericOutputModule< GetPropType< TypeTag, Properties::FluidSystem > >::summaryConfig_

protectedinherited

summaryState_

const SummaryState& Opm::GenericOutputModule< GetPropType< TypeTag, Properties::FluidSystem > >::summaryState_

protectedinherited

swMax_

ScalarBuffer Opm::GenericOutputModule< GetPropType< TypeTag, Properties::FluidSystem > >::swMax_

protectedinherited

swmin_

ScalarBuffer Opm::GenericOutputModule< GetPropType< TypeTag, Properties::FluidSystem > >::swmin_

protectedinherited

temperature_

ScalarBuffer Opm::GenericOutputModule< GetPropType< TypeTag, Properties::FluidSystem > >::temperature_

protectedinherited

tpsaC_

TpsaContainer<Scalar> Opm::GenericOutputModule< GetPropType< TypeTag, Properties::FluidSystem > >::tpsaC_

protectedinherited

tracerC_

TracerContainer<GetPropType< TypeTag, Properties::FluidSystem > > Opm::GenericOutputModule< GetPropType< TypeTag, Properties::FluidSystem > >::tracerC_

protectedinherited

viscosity_

std::array<ScalarBuffer, numPhases> Opm::GenericOutputModule< GetPropType< TypeTag, Properties::FluidSystem > >::viscosity_

protectedinherited

waterVaporizationFactor_

ScalarBuffer Opm::GenericOutputModule< GetPropType< TypeTag, Properties::FluidSystem > >::waterVaporizationFactor_

protectedinherited

---

The documentation for this class was generated from the following file:

• OutputCompositionalModule.hpp