Public Member Functions | Friends | List of all members
forceSuSp Class Reference

Helper container for force Su and Sp terms. More...

Inheritance diagram for forceSuSp:
Inheritance graph
[legend]
Collaboration diagram for forceSuSp:
Collaboration graph
[legend]

Public Member Functions

 forceSuSp ()
 Construct null. More...
 
 forceSuSp (const Tuple2< vector, scalar > &susp)
 Construct given Tuple2. More...
 
 forceSuSp (const vector &Su, const scalar Sp)
 Construct given two components. More...
 
 forceSuSp (Istream &)
 Construct from Istream. More...
 
const vectorSu () const
 Return const access to the explicit contribution [kg.m/s2]. More...
 
scalar Sp () const
 Return const access to the implicit coefficient [kg/s]. More...
 
vectorSu ()
 Return reference to the explicit contribution. More...
 
scalar & Sp ()
 Return reference to the implicit coefficient. More...
 
void operator= (const forceSuSp &susp)
 Assignment. More...
 
void operator+= (const forceSuSp &susp)
 Addition. More...
 
void operator-= (const forceSuSp &susp)
 Subtraction. More...
 
- Public Member Functions inherited from Tuple2< vector, scalar >
 Tuple2 ()
 Null constructor for lists. More...
 
 Tuple2 (const vector &f, const scalar &s)
 Construct from components. More...
 
 Tuple2 (Istream &is)
 Construct from Istream. More...
 
const vectorfirst () const
 Return first. More...
 
vectorfirst ()
 Return first. More...
 
const scalar & second () const
 Return second. More...
 
scalar & second ()
 Return second. More...
 

Friends

forceSuSp operator* (const forceSuSp &susp1, const forceSuSp &susp2)
 Addition. More...
 
forceSuSp operator* (const scalar s, const forceSuSp &susp)
 Multiplication. More...
 

Detailed Description

Helper container for force Su and Sp terms.

F = Sp(U - Up) + Su

Explicit contribution, Su specified as a force Implicit coefficient, Sp specified as force/velocity

Source files

Definition at line 58 of file forceSuSp.H.

Constructor & Destructor Documentation

forceSuSp ( )
inline

Construct null.

Definition at line 28 of file forceSuSpI.H.

Referenced by Foam::operator+().

Here is the caller graph for this function:

forceSuSp ( const Tuple2< vector, scalar > &  susp)
inline

Construct given Tuple2.

Definition at line 33 of file forceSuSpI.H.

forceSuSp ( const vector Su,
const scalar  Sp 
)
inline

Construct given two components.

Definition at line 41 of file forceSuSpI.H.

References Tuple2< vector, scalar >::first(), Tuple2< vector, scalar >::second(), forceSuSp::Sp(), and forceSuSp::Su().

Here is the call graph for this function:

forceSuSp ( Istream is)
inline

Construct from Istream.

Definition at line 48 of file forceSuSpI.H.

Member Function Documentation

const Foam::vector & Su ( ) const
inline
Foam::scalar Sp ( ) const
inline
Foam::vector & Su ( )
inline

Return reference to the explicit contribution.

Definition at line 68 of file forceSuSpI.H.

References Tuple2< vector, scalar >::first().

Here is the call graph for this function:

Foam::scalar & Sp ( )
inline

Return reference to the implicit coefficient.

Definition at line 74 of file forceSuSpI.H.

References Tuple2< vector, scalar >::second().

Here is the call graph for this function:

void operator= ( const forceSuSp susp)
inline

Assignment.

Definition at line 82 of file forceSuSpI.H.

References Tuple2< vector, scalar >::first(), Tuple2< Type1, Type2 >::first(), Tuple2< vector, scalar >::second(), and Tuple2< Type1, Type2 >::second().

Here is the call graph for this function:

void operator+= ( const forceSuSp susp)
inline

Addition.

Definition at line 89 of file forceSuSpI.H.

References Tuple2< vector, scalar >::first(), Tuple2< Type1, Type2 >::first(), Tuple2< vector, scalar >::second(), and Tuple2< Type1, Type2 >::second().

Here is the call graph for this function:

void operator-= ( const forceSuSp susp)
inline

Subtraction.

Definition at line 96 of file forceSuSpI.H.

References Tuple2< vector, scalar >::first(), Tuple2< Type1, Type2 >::first(), Tuple2< vector, scalar >::second(), and Tuple2< Type1, Type2 >::second().

Here is the call graph for this function:

Friends And Related Function Documentation

forceSuSp operator* ( const forceSuSp susp1,
const forceSuSp susp2 
)
friend

Addition.

forceSuSp operator* ( const scalar  s,
const forceSuSp susp 
)
friend

Multiplication.


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