Tuple2 Class Reference

A 2-tuple for storing two objects of different types. More...

Inheritance diagram for Tuple2:

Public Member Functions
	Tuple2 ()
	Null constructor for lists. More...
	Tuple2 (const Type1 &f, const Type2 &s)
	Construct from components. More...
	Tuple2 (Istream &is)
	Construct from Istream. More...
const Type1 &	first () const
	Return first. More...
Type1 &	first ()
	Return first. More...
const Type2 &	second () const
	Return second. More...
Type2 &	second ()
	Return second. More...

Private Attributes
Type1	f_
Type2	s_

Friends
Istream &	operator>> (Istream &is, Tuple2< Type1, Type2 > &t2)
	Read Tuple2 from Istream, discarding contents of existing Tuple2. More...
Ostream &	operator (Ostream &os, const Tuple2< Type1, Type2 > &t2)

Detailed Description

A 2-tuple for storing two objects of different types.

See also

Foam::Pair for storing two objects of identical types.

Definition at line 47 of file Tuple2.H.

Constructor & Destructor Documentation

Tuple2() [1/3]

Tuple2 ( )

inline

Null constructor for lists.

Definition at line 74 of file Tuple2.H.

Tuple2() [2/3]

Tuple2 ( const Type1 &  f, const Type2 &  s  )

inline

Construct from components.

Definition at line 78 of file Tuple2.H.

Tuple2() [3/3]

Tuple2 ( Istream &  is )

inline

Construct from Istream.

Definition at line 85 of file Tuple2.H.

Member Function Documentation

first() [1/2]

const Type1& first ( ) const

inline

Return first.

Definition at line 94 of file Tuple2.H.

Referenced by correctedCellVolumeWeightMethod::calculateAddressing(), regionToFace::combine(), pointConstraint::combine(), autoSnapDriver::determineBaffleFeatures(), autoSnapDriver::determineFeatures(), autoSnapDriver::featureAttractionUsingReconstruction(), autoSnapDriver::findDiagonalAttraction(), patchProbes::findElements(), meshToMeshMethod::interVolAndCentroid(), autoSnapDriver::isSplitAlignedWithFeature(), main(), Foam::operator+(), forceSuSp::operator+=(), forceSuSp::operator-=(), forceSuSp::operator=(), Foam::operator==(), Foam::reverse(), sixDoFRigidBodyMotion::rotate(), symplectic::solve(), Newmark::solve(), and Foam::transform().

Here is the caller graph for this function:

first() [2/2]

Type1& first ( )

inline

Return first.

Definition at line 100 of file Tuple2.H.

second() [1/2]

const Type2& second ( ) const

inline

Return second.

Definition at line 106 of file Tuple2.H.

Referenced by correctedCellVolumeWeightMethod::calculateAddressing(), regionToFace::combine(), pointConstraint::combine(), autoSnapDriver::determineBaffleFeatures(), autoSnapDriver::determineFeatures(), patchProbes::findElements(), meshToMeshMethod::interVolAndCentroid(), autoSnapDriver::isSplitAlignedWithFeature(), main(), Foam::operator+(), forceSuSp::operator+=(), forceSuSp::operator-=(), forceSuSp::operator=(), Foam::operator==(), Foam::reverse(), sixDoFRigidBodyMotion::rotate(), symplectic::solve(), and Foam::transform().

Here is the caller graph for this function:

second() [2/2]

Type2& second ( )

inline

Return second.

Definition at line 112 of file Tuple2.H.

Friends And Related Function Documentation

operator>>

Istream& operator>> ( Istream &  is, Tuple2< Type1, Type2 > &  t2  )

friend

Read Tuple2 from Istream, discarding contents of existing Tuple2.

Definition at line 167 of file Tuple2.H.

operator

Ostream& operator ( Ostream &  os, const Tuple2< Type1, Type2 > &  t2  )

friend

Field Documentation

f_

Type1 f_

private

Definition at line 65 of file Tuple2.H.

Referenced by Tuple2< scalar, Foam::Vector >::first(), Foam::operator<<(), and Foam::operator>>().

s_

Type2 s_

private

Definition at line 66 of file Tuple2.H.

Referenced by Foam::operator<<(), Foam::operator>>(), and Tuple2< scalar, Foam::Vector >::second().

---

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

• src/OpenFOAM/primitives/Tuple2/Tuple2.H