Opm::BoundaryFaceInfo Struct Reference

#include <BoundaryPeriodicity.hpp>

Public Member Functions
bool	operator< (const BoundaryFaceInfo &other) const

Public Attributes
int	face_index
	Face index in [0, ..., #faces - 1]. More...
int	bid
	Boundary id of this face. More...
int	canon_pos
int	partner_face_index
	Face index of periodic partner, or -1 if no partner. More...
int	partner_bid
	Boundary id of periodic partner face, or 0 if no parner. More...
double	area
	Face area. More...
Dune::FieldVector< double, 3 >	centroid
	Face centroid. More...

Detailed Description

Member Function Documentation

operator<()

bool Opm::BoundaryFaceInfo::operator< ( const BoundaryFaceInfo &  other ) const

inline

Comparison operator. Intended to make periodic partners appear close in sorted order, but this is only a heuristic.

Member Data Documentation

area

double Opm::BoundaryFaceInfo::area

Face area.

Referenced by Opm::findPeriodicPartners().

bid

int Opm::BoundaryFaceInfo::bid

Boundary id of this face.

Referenced by Opm::findPeriodicPartners().

canon_pos

int Opm::BoundaryFaceInfo::canon_pos

Canonical position of face: 0 -> xmin 1 -> xmax 2 -> ymin 3 -> ymax ...

Referenced by Opm::findPeriodicPartners().

centroid

Dune::FieldVector<double,3> Opm::BoundaryFaceInfo::centroid

Face centroid.

Referenced by Opm::findPeriodicPartners().

face_index

int Opm::BoundaryFaceInfo::face_index

Face index in [0, ..., #faces - 1].

Referenced by Opm::findPeriodicPartners().

partner_bid

int Opm::BoundaryFaceInfo::partner_bid

Boundary id of periodic partner face, or 0 if no parner.

Referenced by Opm::findPeriodicPartners().

partner_face_index

int Opm::BoundaryFaceInfo::partner_face_index

Face index of periodic partner, or -1 if no partner.

Referenced by Opm::findPeriodicPartners().

---

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

• BoundaryPeriodicity.hpp