Public Member Functions | List of all members
coneVelocityLagrangianVectorFieldSource Class Reference

This source condition provides a conical velocity profile, characterised by a centreline velocity and inner and outer cone angles. The centreline velocity is a Function1 and can vary with time. This is likely to be used in conjunction with a point injection model. More...

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

Public Member Functions

 TypeName ("coneVelocity")
 Runtime type information. More...
 
 coneVelocityLagrangianVectorFieldSource (const regIOobject &, const dictionary &dict)
 Construct from internal field and dictionary. More...
 
 coneVelocityLagrangianVectorFieldSource (const coneVelocityLagrangianVectorFieldSource &, const regIOobject &)
 Copy constructor setting the internal field reference. More...
 
virtual autoPtr< LagrangianVectorFieldSource > clone (const regIOobject &iIo) const
 Construct and return a clone setting the internal field reference. More...
 
virtual ~coneVelocityLagrangianVectorFieldSource ()
 Destructor. More...
 
virtual tmp< LagrangianSubVectorField > value (const LagrangianInjection &, const LagrangianSubMesh &) const
 Return the value for an instantaneous injection. More...
 
virtual void write (Ostream &) const
 Write. More...
 

Detailed Description

This source condition provides a conical velocity profile, characterised by a centreline velocity and inner and outer cone angles. The centreline velocity is a Function1 and can vary with time. This is likely to be used in conjunction with a point injection model.

Usage
Property Description Required? Default
Ucentre The velocity along the centreline yes
thetaInner The inner cone angle yes
thetaOuter The outer cone angle yes

Example specification: 

    <LagrangianModelName>
    {
        type            coneVelocity;
        Ucentre
        {
            type            table;
            values
            (
                (0 (0.1 0 0))
                (0.5 (0.5 0 0))
            );
        }
        thetaInner      15 [deg];
        thetaOuter      22.5 [deg];
    }
See also
Foam::Function1s
Source files

Definition at line 103 of file coneVelocityLagrangianVectorFieldSource.H.

Constructor & Destructor Documentation

◆ coneVelocityLagrangianVectorFieldSource() [1/2]

coneVelocityLagrangianVectorFieldSource ( const regIOobject &  iIo,
const dictionary &  dict 
)

Construct from internal field and dictionary.

Definition at line 31 of file coneVelocityLagrangianVectorFieldSource.C.

Referenced by coneVelocityLagrangianVectorFieldSource::clone().

Here is the caller graph for this function:

◆ coneVelocityLagrangianVectorFieldSource() [2/2]

coneVelocityLagrangianVectorFieldSource ( const coneVelocityLagrangianVectorFieldSource &  field,
const regIOobject &  iIo 
)

Copy constructor setting the internal field reference.

Definition at line 54 of file coneVelocityLagrangianVectorFieldSource.C.

◆ ~coneVelocityLagrangianVectorFieldSource()

~coneVelocityLagrangianVectorFieldSource ( )
virtual

Destructor.

Definition at line 70 of file coneVelocityLagrangianVectorFieldSource.C.

Member Function Documentation

◆ TypeName()

TypeName ( "coneVelocity"  )

Runtime type information.

◆ clone()

virtual autoPtr<LagrangianVectorFieldSource> clone ( const regIOobject &  iIo) const
inlinevirtual

Construct and return a clone setting the internal field reference.

Definition at line 146 of file coneVelocityLagrangianVectorFieldSource.H.

References coneVelocityLagrangianVectorFieldSource::coneVelocityLagrangianVectorFieldSource().

Here is the call graph for this function:

◆ value()

Foam::tmp< Foam::LagrangianSubVectorField > value ( const LagrangianInjection &  injection,
const LagrangianSubMesh &  subMesh 
) const
virtual

Return the value for an instantaneous injection.

Definition at line 78 of file coneVelocityLagrangianVectorFieldSource.C.

References Foam::mag().

Here is the call graph for this function:

◆ write()

void write ( Ostream &  os) const
virtual

Write.

Definition at line 92 of file coneVelocityLagrangianVectorFieldSource.C.

References Foam::dimVelocity, Foam::dimensions::time, coneDirectionLagrangianVectorFieldSource::write(), Foam::vtkWriteOps::write(), and Foam::writeEntry().

Here is the call graph for this function:
The documentation for this class was generated from the following files: