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

Inheritance diagram for forceSuSp:

Collaboration diagram for forceSuSp:

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 vector &	Su () 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...

vector &	Su ()
	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 vector &	first () const
	Return first. More...

vector &	first ()
	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 61 of file forceSuSp.H.

Constructor & Destructor Documentation

◆ forceSuSp() [1/4]

forceSuSp ( )

inline

Construct null.

Definition at line 28 of file forceSuSpI.H.

Referenced by Foam::operator*(), and Foam::operator+().

Here is the caller graph for this function:

◆ forceSuSp() [2/4]

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

inline

Construct given Tuple2.

Definition at line 33 of file forceSuSpI.H.

◆ forceSuSp() [3/4]

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() [4/4]

forceSuSp ( Istream & is )

inline

Construct from Istream.

Definition at line 48 of file forceSuSpI.H.

Member Function Documentation

◆ Su() [1/2]

const Foam::vector & Su ( ) const

inline

Return const access to the explicit contribution [kg.m/s2].

Definition at line 56 of file forceSuSpI.H.

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Sp() [1/2]

Foam::scalar Sp ( ) const

inline

Return const access to the implicit coefficient [kg/s].

Definition at line 62 of file forceSuSpI.H.

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

Referenced by SprayParcel< ParcelType >::calcBreakup(), SphereDragForce< CloudType >::calcCoupled(), DistortedSphereDragForce< CloudType >::calcCoupled(), NonSphereDragForce< CloudType >::calcCoupled(), ParticleForce< CloudType >::calcCoupled(), ParticleForce< CloudType >::calcNonCoupled(), KinematicParcel< ParcelType >::calcVelocity(), and forceSuSp::forceSuSp().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Su() [2/2]

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:

◆ Sp() [2/2]

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:

◆ operator=()

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:

◆ operator+=()

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:

◆ operator-=()

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

◆ operator* [1/2]

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

friend

Addition.

◆ operator* [2/2]

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

friend

Multiplication.

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

src/lagrangian/intermediate/submodels/Kinematic/ParticleForces/forceSuSp/forceSuSp.H
src/lagrangian/intermediate/submodels/Kinematic/ParticleForces/forceSuSp/forceSuSpI.H

Public Member Functions

Friends

Detailed Description

Constructor & Destructor Documentation

◆ forceSuSp() [1/4]

◆ forceSuSp() [2/4]

◆ forceSuSp() [3/4]

◆ forceSuSp() [4/4]

Member Function Documentation

◆ Su() [1/2]

◆ Sp() [1/2]

◆ Su() [2/2]

◆ Sp() [2/2]

◆ operator=()

◆ operator+=()

◆ operator-=()

Friends And Related Function Documentation

◆ operator* [1/2]

◆ operator* [2/2]