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 ()=default
 
 forceSuSp (const Foam::zero)
 
 forceSuSp (const Tuple2< vector, scalar > &susp)
 
 forceSuSp (const vector &Su, const scalar Sp)
 
 forceSuSp (Istream &is)
 
const vectorSu () const
 
scalar Sp () const
 
vectorSu ()
 
scalar & Sp ()
 
void operator+= (const forceSuSp &susp)
 
void operator-= (const forceSuSp &susp)
 
- Public Member Functions inherited from Tuple2< vector, scalar >
 Tuple2 ()=default
 
 Tuple2 (const T1 &f, const T2 &s)
 
 Tuple2 (T1 &&f, T2 &&s)
 
 Tuple2 (const std::pair< T1, T2 > &vals)
 
 Tuple2 (std::pair< T1, T2 > &&vals)
 
 Tuple2 (Istream &is)
 
const T1 & first () const noexcept
 
T1 & first () noexcept
 
const T2 & second () const noexcept
 
T2 & second () noexcept
 

Friends

forceSuSp operator* (const forceSuSp &susp1, const forceSuSp &susp2)
 
forceSuSp operator* (const scalar s, const forceSuSp &susp)
 

Additional Inherited Members

- Public Types inherited from Tuple2< vector, scalar >
typedef T1 first_type
 
typedef T2 second_type
 

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 60 of file forceSuSp.H.

Constructor & Destructor Documentation

◆ forceSuSp() [1/5]

forceSuSp ( )
default

◆ forceSuSp() [2/5]

forceSuSp ( const Foam::zero  )
inline

Definition at line 24 of file forceSuSpI.H.

◆ forceSuSp() [3/5]

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

Definition at line 31 of file forceSuSpI.H.

◆ forceSuSp() [4/5]

forceSuSp ( const vector Su,
const scalar  Sp 
)
inline

Definition at line 39 of file forceSuSpI.H.

References Sp, and Su.

◆ forceSuSp() [5/5]

forceSuSp ( Istream is)
inlineexplicit

Definition at line 46 of file forceSuSpI.H.

Member Function Documentation

◆ Su() [1/2]

Foam::vector & Su ( ) const
inline

◆ Sp() [1/2]

Foam::scalar & Sp ( ) const
inline

◆ Su() [2/2]

vector& Su ( )
inline

◆ Sp() [2/2]

scalar& Sp ( )
inline

◆ operator+=()

void operator+= ( const forceSuSp susp)
inline

Definition at line 80 of file forceSuSpI.H.

References Tuple2::first(), and Tuple2::second().

Here is the call graph for this function:

◆ operator-=()

void operator-= ( const forceSuSp susp)
inline

Definition at line 87 of file forceSuSpI.H.

References Tuple2::first(), and Tuple2::second().

Here is the call graph for this function:

Friends And Related Function Documentation

◆ operator* [1/2]

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

◆ operator* [2/2]

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

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