Public Types |
Public Member Functions |
Static Public Member Functions |
Static Public Attributes |
Protected Types |
Protected Member Functions |
Static Protected Member Functions |
Protected Attributes |
Static Protected Attributes |
List of all members
Opm::FlowBaseVanguard< TypeTag > Class Template Reference Helper class for grid instantiation of ECL file-format using problems. More...
Inheritance diagram for Opm::FlowBaseVanguard< TypeTag >:
Detailed Descriptiontemplate<class TypeTag> class Opm::FlowBaseVanguard< TypeTag > Helper class for grid instantiation of ECL file-format using problems. Member Typedef Documentation◆ CartesianIndexMapper
template<class TypeTag >
◆ Element
template<class TypeTag >
◆ Grid
template<class TypeTag >
◆ GridView
template<class TypeTag >
◆ ParallelWellStruct
Constructor & Destructor Documentation◆ FlowBaseVanguard()
template<class TypeTag >
Create the grid for problem data files which use the ECL file format. This is the file format used by the commercial ECLiPSE simulator. Usually it uses a cornerpoint description of the grid. References Opm::FlowGenericVanguard::edgeWeightsMethod_, Opm::FlowGenericVanguard::enableDistributedWells_, Opm::FlowGenericVanguard::enableExperiments_, Opm::FlowGenericVanguard::externalPartitionFile_, Opm::FlowGenericVanguard::fileName_, Opm::FlowGenericVanguard::ignoredKeywords_, Opm::FlowGenericVanguard::imbalanceTol_, Opm::FlowGenericVanguard::init(), Opm::FlowGenericVanguard::metisParams_, Opm::FlowGenericVanguard::outputInterval_, Opm::FlowGenericVanguard::ownersFirst_, Opm::FlowGenericVanguard::partitionMethod_, Opm::FlowGenericVanguard::serialPartitioning_, Opm::FlowGenericVanguard::useMultisegmentWell_, Opm::FlowGenericVanguard::zoltanImbalanceTol_, Opm::FlowGenericVanguard::zoltanImbalanceTolSet_, and Opm::FlowGenericVanguard::zoltanParams_. Member Function Documentation◆ actionState() [1/2]
Returns the action state. The ActionState keeps track of how many times the various actions have run. References Opm::FlowGenericVanguard::actionState_. ◆ actionState() [2/2]
References Opm::FlowGenericVanguard::actionState_. ◆ allAquiferCells()
Referenced by Opm::FlowBaseVanguard< TypeTag >::updateCellDepths_(). ◆ callImplementationInit()
template<class TypeTag >
◆ canonicalDeckPath()
Returns the canonical path to a deck file. The input can either be the canonical deck file name or the name of the case (i.e., without the .DATA extension) ◆ cartesianCoordinate()
template<class TypeTag >
Extract Cartesian index triplet (i,j,k) of an active cell.
◆ cartesianDimensions()
template<class TypeTag >
Returns the number of logically Cartesian cells in each direction. Referenced by Opm::FlowBaseVanguard< TypeTag >::cartesianIndex(). ◆ cartesianIndex() [1/2]
template<class TypeTag >
Return the index of the cells in the logical Cartesian grid. References Opm::FlowBaseVanguard< TypeTag >::cartesianDimensions(), and Opm::FlowBaseVanguard< TypeTag >::dimension. ◆ cartesianIndex() [2/2]
template<class TypeTag >
Returns the Cartesian cell id for identifaction with ECL data. Referenced by Opm::FlowBaseVanguard< TypeTag >::updateCartesianToCompressedMapping_(), and Opm::FlowBaseVanguard< TypeTag >::updateCellDepths_(). ◆ cartesianMapper()
template<class TypeTag >
◆ cartesianSize()
template<class TypeTag >
Returns the overall number of cells of the logically Cartesian grid. ◆ caseName()
Returns the name of the case. i.e., the all-uppercase version of the file name from which the deck is loaded with the ".DATA" suffix removed. References Opm::FlowGenericVanguard::caseName_. ◆ cellCenterDepth()
template<class TypeTag >
Returns the depth of a degree of freedom [m]. For ECL problems this is defined as the average of the depth of an element and is thus slightly different from the depth of an element's centroid. References Opm::FlowBaseVanguard< TypeTag >::cellCenterDepth_. Referenced by Opm::FlowBaseVanguard< TypeTag >::updateCellDepths_(). ◆ cellCenterDepths()
template<class TypeTag >
◆ cellCentroids_()
template<class TypeTag >
template<class CartMapper >
Get function to query cell centroids for a distributed grid. Currently this only non-empty for a loadbalanced CpGrid. It is a function return the centroid for the given element index.
References Opm::FlowGenericVanguard::eclState(), and Opm::BaseVanguard< TypeTag >::gridView(). Referenced by Opm::AluGridVanguard< TypeTag >::cellCentroids(), Opm::CpGridVanguard< TypeTag >::cellCentroids(), and Opm::PolyhedralGridVanguard< TypeTag >::cellCentroids(). ◆ cellThickness()
template<class TypeTag >
Returns the thickness of a degree of freedom [m]. For ECL problems this is defined as the average of the depths of the top surface corners minus the average of the depths of the bottom surface corners The cell thickness is computed only when needed. References Opm::FlowBaseVanguard< TypeTag >::cellThickness_. ◆ comm()
Obtain global communicator. References Opm::FlowGenericVanguard::comm_. Referenced by Opm::AluGridVanguard< TypeTag >::AluGridVanguard(), Opm::AluGridVanguard< TypeTag >::createGrids_(), Opm::Main::initialize_(), and Opm::FlowGenericVanguard::setCommunication(). ◆ compressedIndex()
template<class TypeTag >
Return compressed index from cartesian index.
References Opm::FlowBaseVanguard< TypeTag >::cartesianToCompressed_. ◆ compressedIndexForInterior()
template<class TypeTag >
Return compressed index from cartesian index only in interior.
References Opm::FlowBaseVanguard< TypeTag >::cartesianToCompressed_, and Opm::FlowBaseVanguard< TypeTag >::is_interior_. ◆ defineSimulationModel()
Set the simulation configuration objects. ◆ drsdtconEnabled()
Referenced by Opm::FlowBaseVanguard< TypeTag >::updateCellThickness_(). ◆ eclState() [1/2]
References Opm::FlowGenericVanguard::eclState_. ◆ eclState() [2/2]
Return a reference to the internalized ECL deck. References Opm::FlowGenericVanguard::eclState_. Referenced by Opm::CpGridVanguard< TypeTag >::allocTrans(), Opm::FlowBaseVanguard< TypeTag >::cellCentroids_(), Opm::CpGridVanguard< TypeTag >::checkConsistency(), Opm::AluGridVanguard< TypeTag >::createGrids_(), Opm::CpGridVanguard< TypeTag >::createGrids_(), Opm::PolyhedralGridVanguard< TypeTag >::createGrids_(), Opm::AluGridVanguard< TypeTag >::loadBalance(), and Opm::CpGridVanguard< TypeTag >::loadBalance(). ◆ edgeWeightsMethod()
Parameter deciding the edge-weight strategy of the load balancer. References Opm::FlowGenericVanguard::edgeWeightsMethod_. Referenced by Opm::CpGridVanguard< TypeTag >::loadBalance(). ◆ enableDistributedWells()
Whether perforations of a well might be distributed. References Opm::FlowGenericVanguard::enableDistributedWells_. Referenced by Opm::CpGridVanguard< TypeTag >::loadBalance(). ◆ equilCartesianCoordinate()
template<class TypeTag >
Extract Cartesian index triplet (i,j,k) of an active cell of the grid used for EQUIL.
◆ equilCartesianIndex()
template<class TypeTag >
Returns the Cartesian cell id given an element index for the grid used for equilibration. ◆ equilCartesianSize()
template<class TypeTag >
Returns the overall number of cells of the logically EquilCartesian grid. ◆ externalPartitionFile()
References Opm::FlowGenericVanguard::externalPartitionFile_. Referenced by Opm::CpGridVanguard< TypeTag >::loadBalance(). ◆ finalizeInit_()
template<class TypeTag >
References Opm::BaseVanguard< TypeTag >::updateGridView_(). Referenced by Opm::CubeGridVanguard< TypeTag >::CubeGridVanguard(), Opm::DgfVanguard< TypeTag >::DgfVanguard(), Opm::StructuredGridVanguard< TypeTag >::StructuredGridVanguard(), and Opm::UnstructuredGridVanguard< TypeTag >::UnstructuredGridVanguard(). ◆ globalNumCells()
template<class TypeTag >
Get the number of cells in the global leaf grid view. \warn This is a collective operation that needs to be called on all ranks. References Opm::BaseVanguard< TypeTag >::gridView(). ◆ gridSequenceNumber()
template<class TypeTag >
Returns the number of times the grid has been changed since its creation. This basically says how often the grid has been adapted in the current simulation run. ◆ gridView()
template<class TypeTag >
Returns a reference to the grid view to be used. Referenced by Opm::DgfVanguard< TypeTag >::addFractures_(), Opm::CpGridVanguard< TypeTag >::allocTrans(), Opm::FlowBaseVanguard< TypeTag >::cellCentroids_(), Opm::FlowBaseVanguard< TypeTag >::globalNumCells(), Opm::AluGridVanguard< TypeTag >::loadBalance(), Opm::CpGridVanguard< TypeTag >::loadBalance(), Opm::PolyhedralGridVanguard< TypeTag >::PolyhedralGridVanguard(), Opm::FlowBaseVanguard< TypeTag >::updateCartesianToCompressedMapping_(), Opm::FlowBaseVanguard< TypeTag >::updateCellDepths_(), and Opm::FlowBaseVanguard< TypeTag >::updateCellThickness_(). ◆ imbalanceTol()
Parameter that sets the imbalance tolarance, depending on the chosen partition method. References Opm::FlowGenericVanguard::imbalanceTol_, Opm::FlowGenericVanguard::zoltanImbalanceTol_, and Opm::FlowGenericVanguard::zoltanImbalanceTolSet_. Referenced by Opm::CpGridVanguard< TypeTag >::loadBalance(). ◆ init()
Referenced by Opm::FlowBaseVanguard< TypeTag >::FlowBaseVanguard(). ◆ loadBalance()
template<class TypeTag >
Distribute the grid (and attached data) over all processes. References Opm::BaseVanguard< TypeTag >::updateGridView_(). ◆ numJacobiBlocks()
Number of blocks in the Block-Jacobi preconditioner. Referenced by Opm::CpGridVanguard< TypeTag >::loadBalance(). ◆ operator==()
◆ ownersFirst()
Parameter that decide if cells owned by rank are ordered before ghost cells. References Opm::FlowGenericVanguard::ownersFirst_. Referenced by Opm::CpGridVanguard< TypeTag >::loadBalance(). ◆ parallelWells()
Returns vector with name and whether the has local perforated cells for all wells. Will only have usable values for CpGrid. References Opm::FlowGenericVanguard::parallelWells_. ◆ partitionMethod()
Parameter deciding which partition method to use. References Opm::FlowGenericVanguard::partitionMethod_. Referenced by Opm::CpGridVanguard< TypeTag >::loadBalance(). ◆ readDeck()
Read a deck.
◆ registerParameters()
template<class TypeTag >
Register the common run-time parameters for all ECL simulator vanguards. ◆ registerParameters_()
template<class Scalar >
◆ schedule() [1/2]
References Opm::FlowGenericVanguard::eclSchedule_. ◆ schedule() [2/2]
Return a reference to the object that managages the ECL schedule. References Opm::FlowGenericVanguard::eclSchedule_. Referenced by Opm::CpGridVanguard< TypeTag >::filterConnections_(), and Opm::CpGridVanguard< TypeTag >::loadBalance(). ◆ serializationTestParams()
◆ serializeOp()
template<class Serializer >
◆ serialPartitioning()
Parameter that decides if partitioning for parallel runs should be performed on a single process only. References Opm::FlowGenericVanguard::serialPartitioning_. Referenced by Opm::CpGridVanguard< TypeTag >::loadBalance(). ◆ setCommunication()
Set global communication. References Opm::FlowGenericVanguard::comm(), and Opm::FlowGenericVanguard::comm_. ◆ setupCartesianToCompressed_()
template<class TypeTag >
◆ setupTime()
Returns the wall time required to set up the simulator before it was born. References Opm::FlowGenericVanguard::setupTime_. ◆ summaryConfig()
Return a reference to the object that determines which quantities ought to be put into the ECL summary output. References Opm::FlowGenericVanguard::eclSummaryConfig_. ◆ summaryState() [1/2]
Returns the summary state. The summary state is a small container object for computed, ready to use summary values. The values will typically be used by the UDQ, WTEST and ACTIONX calculations. References Opm::FlowGenericVanguard::summaryState_. ◆ summaryState() [2/2]
References Opm::FlowGenericVanguard::summaryState_. ◆ transferWTestState()
References Opm::FlowGenericVanguard::wtestState_. ◆ udqState() [1/2]
Returns the udq state. The UDQState keeps track of the result of UDQ evaluations. References Opm::FlowGenericVanguard::udqState_. ◆ udqState() [2/2]
References Opm::FlowGenericVanguard::udqState_. ◆ updateCartesianToCompressedMapping_()
template<class TypeTag >
References Opm::FlowBaseVanguard< TypeTag >::cartesianIndex(), Opm::FlowBaseVanguard< TypeTag >::cartesianToCompressed_, Opm::BaseVanguard< TypeTag >::gridView(), and Opm::FlowBaseVanguard< TypeTag >::is_interior_. Referenced by Opm::AluGridVanguard< TypeTag >::createGrids_(), Opm::PolyhedralGridVanguard< TypeTag >::createGrids_(), Opm::CpGridVanguard< TypeTag >::loadBalance(), and Opm::FlowBaseVanguard< TypeTag >::setupCartesianToCompressed_(). ◆ updateCellDepths_()
template<class TypeTag >
References Opm::FlowGenericVanguard::allAquiferCells(), Opm::FlowBaseVanguard< TypeTag >::cartesianIndex(), Opm::FlowBaseVanguard< TypeTag >::cellCenterDepth(), Opm::FlowBaseVanguard< TypeTag >::cellCenterDepth_, and Opm::BaseVanguard< TypeTag >::gridView(). Referenced by Opm::AluGridVanguard< TypeTag >::createGrids_(), Opm::PolyhedralGridVanguard< TypeTag >::createGrids_(), and Opm::CpGridVanguard< TypeTag >::loadBalance(). ◆ updateCellThickness_()
template<class TypeTag >
◆ updateGridView_()
template<class TypeTag >
◆ updateNOSIM_()
◆ updateOutputDir_()
Member Data Documentation◆ actionState_
Referenced by Opm::FlowGenericVanguard::actionState(). ◆ cartesianToCompressed_
template<class TypeTag >
Mapping between cartesian and compressed cells. It is initialized the first time it is called. Referenced by Opm::FlowBaseVanguard< TypeTag >::compressedIndex(), Opm::FlowBaseVanguard< TypeTag >::compressedIndexForInterior(), and Opm::FlowBaseVanguard< TypeTag >::updateCartesianToCompressedMapping_(). ◆ caseName_
Referenced by Opm::FlowGenericVanguard::caseName(). ◆ cellCenterDepth_
template<class TypeTag >
Cell center depths. Referenced by Opm::FlowBaseVanguard< TypeTag >::cellCenterDepth(), Opm::FlowBaseVanguard< TypeTag >::cellCenterDepths(), and Opm::FlowBaseVanguard< TypeTag >::updateCellDepths_(). ◆ cellThickness_
template<class TypeTag >
Cell thickness. Referenced by Opm::FlowBaseVanguard< TypeTag >::cellThickness(), and Opm::FlowBaseVanguard< TypeTag >::updateCellThickness_(). ◆ comm_
Referenced by Opm::FlowGenericVanguard::comm(), and Opm::FlowGenericVanguard::setCommunication(). ◆ dimension
template<class TypeTag >
Referenced by Opm::FlowBaseVanguard< TypeTag >::cartesianIndex(). ◆ dimensionworld
template<class TypeTag >
◆ eclSchedule_
Referenced by Opm::FlowGenericVanguard::schedule(). ◆ eclState_
Referenced by Opm::FlowGenericVanguard::eclState(). ◆ eclSummaryConfig_
Referenced by Opm::FlowGenericVanguard::summaryConfig(). ◆ edgeWeightsMethod_
◆ enableDistributedWells_
◆ enableExperiments_
Referenced by Opm::FlowBaseVanguard< TypeTag >::FlowBaseVanguard(). ◆ externalPartitionFile_
◆ fileName_
Referenced by Opm::FlowBaseVanguard< TypeTag >::FlowBaseVanguard(). ◆ ignoredKeywords_
Referenced by Opm::FlowBaseVanguard< TypeTag >::FlowBaseVanguard(). ◆ imbalanceTol_
◆ is_interior_
template<class TypeTag >
Whether a cells is in the interior. Referenced by Opm::FlowBaseVanguard< TypeTag >::compressedIndexForInterior(), and Opm::FlowBaseVanguard< TypeTag >::updateCartesianToCompressedMapping_(). ◆ metisParams_
◆ modelParams_
◆ outputInterval_
Referenced by Opm::FlowBaseVanguard< TypeTag >::FlowBaseVanguard(). ◆ ownersFirst_
◆ parallelWells_
Information about wells in parallel. For each well in the model there is an entry with its name and a boolean indicating whether it perforates local cells. Referenced by Opm::CpGridVanguard< TypeTag >::loadBalance(), and Opm::FlowGenericVanguard::parallelWells(). ◆ partitionMethod_
◆ python
◆ serialPartitioning_
◆ setupTime_
Referenced by Opm::FlowGenericVanguard::setupTime(). ◆ summaryState_
Referenced by Opm::FlowGenericVanguard::summaryState(). ◆ udqState_
Referenced by Opm::FlowGenericVanguard::udqState(). ◆ useMultisegmentWell_
Referenced by Opm::FlowBaseVanguard< TypeTag >::FlowBaseVanguard(). ◆ wtestState_
Referenced by Opm::FlowGenericVanguard::transferWTestState(). ◆ zoltanImbalanceTol_
◆ zoltanImbalanceTolSet_
◆ zoltanParams_
The documentation for this class was generated from the following file: |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||