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

#include <forceSuSp.H>

Inheritance diagram for forceSuSp:

Collaboration diagram for forceSuSp:

Public Member Functions
	forceSuSp ()=default
	Default construct.
	forceSuSp (const Foam::zero)
	Construct zero-initialized content.
	forceSuSp (const Tuple2< vector, scalar > &susp)
	Construct given Tuple2.
	forceSuSp (const vector &Su, const scalar Sp)
	Construct given two components.
	forceSuSp (Istream &is)
	Construct from Istream.
const vector &	Su () const
	Return const access to the explicit contribution [kg.m/s2].
scalar	Sp () const
	Return const access to the implicit coefficient [kg/s].
vector &	Su ()
	Return reference to the explicit contribution.
scalar &	Sp ()
	Return reference to the implicit coefficient.
void	operator+= (const forceSuSp &susp)
	Addition.
void	operator-= (const forceSuSp &susp)
	Subtraction.
Public Member Functions inherited from Tuple2< vector, scalar >
	Tuple2 ()=default
	Default construct.
const vector &	first () const noexcept
	Access the first element.
const scalar &	second () const noexcept
	Access the second element.

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

Additional Inherited Members
Public Types inherited from Tuple2< vector, scalar >
typedef vector	first_type
	Type of member first, the first template parameter (T1).
typedef scalar	second_type
	Type of member second, the second template parameter (T2).

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

Default construct.

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

Referenced by forceSuSp(), operator*, operator*, operator+=(), and operator-=().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ forceSuSp() [2/5]

forceSuSp ( const Foam::zero )

inline

Construct zero-initialized content.

Definition at line 24 of file forceSuSpI.H.

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

Here is the call graph for this function:

◆ forceSuSp() [3/5]

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

inline

Construct given Tuple2.

Definition at line 30 of file forceSuSpI.H.

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

Here is the call graph for this function:

◆ forceSuSp() [4/5]

forceSuSp	(	const vector &	Su,
		const scalar	Sp )

inline

Construct given two components.

Definition at line 39 of file forceSuSpI.H.

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

Here is the call graph for this function:

◆ forceSuSp() [5/5]

forceSuSp ( Istream & is )

inlineexplicit

Construct from Istream.

Definition at line 46 of file forceSuSpI.H.

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

Here is the call graph for this function:

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

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

Referenced by SprayParcel< ParcelType >::calcBreakup(), ParticleForce< CloudType >::calcCoupled(), ParticleForce< CloudType >::calcNonCoupled(), KinematicParcel< particle >::calcVelocity(), forceSuSp(), and 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 66 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 72 of file forceSuSpI.H.

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

Here is the call graph for this function:

◆ operator+=()

void operator+= ( const forceSuSp & susp )

inline

Addition.

Definition at line 80 of file forceSuSpI.H.

References Tuple2< T1, T2 >::first(), Tuple2< vector, scalar >::first(), forceSuSp(), Tuple2< T1, T2 >::second(), and Tuple2< vector, scalar >::second().

Here is the call graph for this function:

◆ operator-=()

void operator-= ( const forceSuSp & susp )

inline

Subtraction.

Definition at line 87 of file forceSuSpI.H.

References Tuple2< T1, T2 >::first(), Tuple2< vector, scalar >::first(), forceSuSp(), Tuple2< T1, T2 >::second(), and Tuple2< vector, scalar >::second().

Here is the call graph for this function:

◆ operator* [1/2]

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

friend

Addition.

References forceSuSp().

◆ operator* [2/2]

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

friend

Multiplication.

References forceSuSp(), and s().

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

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ forceSuSp() [1/5]

◆ forceSuSp() [2/5]

◆ forceSuSp() [3/5]

◆ forceSuSp() [4/5]

◆ forceSuSp() [5/5]

Member Function Documentation

◆ Su() [1/2]

◆ Sp() [1/2]

◆ Su() [2/2]

◆ Sp() [2/2]

◆ operator+=()

◆ operator-=()

Friends And Related Symbol Documentation

◆ operator* [1/2]

◆ operator* [2/2]