escapeVelocityLagrangianPatchVectorField Class Reference

A escape velocity boundary condition. Particles that hit a patch with this condition will be removed from the simulation. More...

Inheritance diagram for escapeVelocityLagrangianPatchVectorField:

Collaboration diagram for escapeVelocityLagrangianPatchVectorField:

Public Member Functions
	TypeName ("escapeVelocity")
	Runtime type information. More...
virtual autoPtr< LagrangianPatchVectorField >	clone () const
	Construct and return a clone. More...
virtual autoPtr< LagrangianPatchVectorField >	clone (const regIOobject &iIo) const
	Construct and return a clone setting the internal field reference. More...
virtual LagrangianState	state () const
	Return the state after interaction with this patch. More...
Public Member Functions inherited from cloudVelocityLagrangianPatchVectorField
	TypeName ("cloudVelocity")
	Runtime type information. More...

Detailed Description

A escape velocity boundary condition. Particles that hit a patch with this condition will be removed from the simulation.

Usage

Example specification:

<LagrangianPatchName>
{
    type            escapeVelocity;
}

Source files

• escapeVelocityLagrangianPatchVectorField.H
• escapeVelocityLagrangianPatchVectorField.C

Definition at line 58 of file escapeVelocityLagrangianPatchVectorField.H.

Member Function Documentation

TypeName()

TypeName

(

"escapeVelocity"

)

Runtime type information.

clone() [1/2]

virtual autoPtr<LagrangianPatchVectorField> clone ( ) const

inlinevirtual

Construct and return a clone.

Definition at line 76 of file escapeVelocityLagrangianPatchVectorField.H.

clone() [2/2]

virtual autoPtr<LagrangianPatchVectorField> clone ( const regIOobject &  iIo ) const

inlinevirtual

Construct and return a clone setting the internal field reference.

Definition at line 85 of file escapeVelocityLagrangianPatchVectorField.H.

state()

Foam::LagrangianState state ( ) const

virtual

Return the state after interaction with this patch.

Implements cloudVelocityLagrangianPatchVectorField.

Definition at line 32 of file escapeVelocityLagrangianPatchVectorField.C.

References Foam::toBeRemoved.

---

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

• src/Lagrangian/cloud/fields/derivedLagrangianPatchFields/escapeVelocity/escapeVelocityLagrangianPatchVectorField.H
• src/Lagrangian/cloud/fields/derivedLagrangianPatchFields/escapeVelocity/escapeVelocityLagrangianPatchVectorField.C