fixedJump

Description

The fixedJump is a general coupled boundary condition to provide a jump cyclic condition. The jump is specified as a fixed value field, applied as an offset to the 'owner' patch.

Usage

The condition requires entries in both the boundary and field files.

Boundary file

<patchName>
{
    type            patch;
    ...
}

Field file

<patchName>
{
    // Mandatory entries
    type            fixedJump;
    jump            <Field<Type>>;

    // Optional entries
    jump0           <Field<Type>>;
    minJump         <Type>;
    relax           <scalar>;

    // Inherited entries
    patchType       <word>;
    ...
}

where:

Property	Description	Type	Required	Default
type	Type name: fixedJump	word	yes	-
jump	Jump field	Field<Type>	yes	-
jump0	Old-time level jump field	Field<Type>	no	-
minJump	Minimum allowable jump value	Type	no	pTraits<Type>::min
relax	Under-relaxation factor	scalar	no	-1

The inherited entries are elaborated in:

• Foam::jumpCyclicFvPatchField

• The underlying patchType should be set to cyclic.

Further information

Tutorial:

• N/A

Source code:

• fixedJump

API:

• Foam::fixedJumpFvPatchField

History: Introduced in version 2.0.1