Opm::ParallelRegionVariableValues Class Reference

#include <ParallelRegionVariableValues.hpp>

Inheritance diagram for Opm::ParallelRegionVariableValues:

Public Member Functions
	ParallelRegionVariableValues (const Parallel::Communication &comm)
virtual	~ParallelRegionVariableValues ()=default
	Virtual destructor to support inheritance. More...
std::unique_ptr< data::RegionVariableValues >	clone () const override

Protected Member Functions
void	communicateIncrement () override

Detailed Description

Numerical values for set of region level summary variables defined over a collection of region sets.

This is the parallel implementation of the region variable values class. It is intended to be used in conjunction with the parallel region variable descriptor class, and synchronises the region value "increment" values between MPI ranks.

Constructor & Destructor Documentation

ParallelRegionVariableValues()

Opm::ParallelRegionVariableValues::ParallelRegionVariableValues ( const Parallel::Communication &  comm )

explicit

Parameters

[in]

comm

MPI communication object. Copied into the values object; the underlying communicator must remain valid for the values object's lifetime.

~ParallelRegionVariableValues()

virtual Opm::ParallelRegionVariableValues::~ParallelRegionVariableValues ( )

virtualdefault

Virtual destructor to support inheritance.

Member Function Documentation

clone()

std::unique_ptr< data::RegionVariableValues > Opm::ParallelRegionVariableValues::clone ( ) const

override

Create a deep copy of this object.

Intended for when an object holds a pointer to a base class and needs to make a copy of the derived class object.

Returns

A deep copy of this object.

communicateIncrement()

void Opm::ParallelRegionVariableValues::communicateIncrement ( )

overrideprotected

Compute canonical increment_ values.

Sums values across MPI ranks.

---

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

• ParallelRegionVariableValues.hpp