diff --git a/src/finiteVolume/fields/fvPatchFields/derived/fixedJump/fixedJumpFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/fixedJump/fixedJumpFvPatchField.H
index ba2fdc9aeb70787b1ddfe835c44fcfdf95b5c099..ede9fea8af48fca9c9901037f61b5dbd3669f695 100644
--- a/src/finiteVolume/fields/fvPatchFields/derived/fixedJump/fixedJumpFvPatchField.H
+++ b/src/finiteVolume/fields/fvPatchFields/derived/fixedJump/fixedJumpFvPatchField.H
@@ -28,14 +28,37 @@ Group
grpCoupledBoundaryConditions
Description
- Base class for "jump" of a field<type>
+ This boundary condition provides a jump condition, using the \c cyclic
+ condition as a base.
+
+ The jump is specified as a fixed value field, applied as an offset to the
+ 'owner' patch.
+
+ \heading Patch usage
+
+ \table
+ Property | Description | Required | Default value
+ patchType | underlying patch type should be \c cyclic| yes |
+ jump | current jump value | yes |
+ \endtable
+
+ Example of the boundary condition specification:
+ \verbatim
+ myPatch
+ {
+ type fixedJump;
+ patchType cyclic;
+ jump uniform 10;
+ }
+ \endverbatim
+
+ The above example shows the use of a fixed jump of '10'.
Note
- not used directly
+ The underlying \c patchType should be set to \c cyclic
SeeAlso
- Foam::fanFvPatchScalarField
- Foam::fanPressureFvPatchScalarField
+ Foam::jumpCyclicFvPatchField
SourceFiles
fixedJumpFvPatchField.C
diff --git a/src/finiteVolume/fields/fvPatchFields/derived/fixedJumpAMI/fixedJumpAMIFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/fixedJumpAMI/fixedJumpAMIFvPatchField.H
index 9e9d1a91d10e1ec6a8f5d4ea06056472fb5561ff..9a0c4bf52048c20f0a67d1b9054f763f020b417b 100644
--- a/src/finiteVolume/fields/fvPatchFields/derived/fixedJumpAMI/fixedJumpAMIFvPatchField.H
+++ b/src/finiteVolume/fields/fvPatchFields/derived/fixedJumpAMI/fixedJumpAMIFvPatchField.H
@@ -27,6 +27,36 @@ Class
Group
grpCoupledBoundaryConditions
+Description
+ This boundary condition provides a jump condition, across non-conformal
+ cyclic path-pairs, employing an arbitraryMeshInterface (AMI).
+
+ The jump is specified as a fixed value field, applied as an offset to the
+ 'owner' patch.
+
+ \heading Patch usage
+
+ \table
+ Property | Description | Required | Default value
+ patchType | underlying patch type should be \c cyclic| yes |
+ jump | current jump value | yes |
+ \endtable
+
+ Example of the boundary condition specification:
+ \verbatim
+ myPatch
+ {
+ type fixedJumpAMI;
+ patchType cyclic;
+ jump uniform 10;
+ }
+ \endverbatim
+
+ The above example shows the use of a fixed jump of '10'.
+
+Note
+ The underlying \c patchType should be set to \c cyclicAMI
+
SeeAlso
Foam::jumpCyclicAMIFvPatchField
diff --git a/src/finiteVolume/fields/fvPatchFields/derived/uniformJump/uniformJumpFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/uniformJump/uniformJumpFvPatchField.H
index d7e8706a59d7aebcfb95c55225bb587f0ae906ad..7e419a2b1ceb215270d769848ff2ed1d473a8c96 100644
--- a/src/finiteVolume/fields/fvPatchFields/derived/uniformJump/uniformJumpFvPatchField.H
+++ b/src/finiteVolume/fields/fvPatchFields/derived/uniformJump/uniformJumpFvPatchField.H
@@ -27,11 +27,39 @@ Class
Group
grpCoupledBoundaryConditions
-Description
- Uniform jump
+ This boundary condition provides a jump condition, using the \c cyclic
+ condition as a base. The jump is specified as a time-varying uniform
+ value across the patch.
+
+ \heading Patch usage
+
+ \table
+ Property | Description | Required | Default value
+ patchType | underlying patch type should be \c cyclic| yes |
+ jumpTable | jump value | yes |
+ \endtable
+
+ Example of the boundary condition specification:
+ \verbatim
+ myPatch
+ {
+ type fixedJump;
+ patchType cyclic;
+ jumpTable constant 10;
+ }
+ \endverbatim
+
+ The above example shows the use of a fixed jump of '10'.
+
+Note
+ The uniformValue entry is a DataEntry type, able to describe time
+ varying functions. The example above gives the usage for supplying a
+ constant value.
+
+ The underlying \c patchType should be set to \c cyclic
SeeAlso
- Foam::jumpCyclicFvPatchField
+ Foam::fixedJumpFvPatchField
SourceFiles
uniformJumpFvPatchField.C
diff --git a/src/finiteVolume/fields/fvPatchFields/derived/uniformJumpAMI/uniformJumpAMIFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/uniformJumpAMI/uniformJumpAMIFvPatchField.H
index ddd891dcad3113c7a7560887970f1330da5882b7..e64382975f2584b3731e413e102fc70a0f992a1d 100644
--- a/src/finiteVolume/fields/fvPatchFields/derived/uniformJumpAMI/uniformJumpAMIFvPatchField.H
+++ b/src/finiteVolume/fields/fvPatchFields/derived/uniformJumpAMI/uniformJumpAMIFvPatchField.H
@@ -28,7 +28,36 @@ Group
grpCoupledBoundaryConditions
Description
- Uniform jump
+ This boundary condition provides a jump condition, using the \c cyclicAMI
+ condition as a base. The jump is specified as a time-varying uniform
+ value across the patch.
+
+ \heading Patch usage
+
+ \table
+ Property | Description | Required | Default value
+ patchType | underlying patch type should be \c cyclic| yes |
+ jumpTable | jump value | yes |
+ \endtable
+
+ Example of the boundary condition specification:
+ \verbatim
+ myPatch
+ {
+ type uniformJumpAMI;
+ patchType cyclicAMI;
+ jumpTable constant 10;
+ }
+ \endverbatim
+
+ The above example shows the use of a fixed jump of '10'.
+
+Note
+ The uniformValue entry is a DataEntry type, able to describe time
+ varying functions. The example above gives the usage for supplying a
+ constant value.
+
+ The underlying \c patchType should be set to \c cyclic
SeeAlso
Foam::jumpCyclicAMIFvPatchField
diff --git a/src/thermophysicalModels/basic/derivedFvPatchFields/energyJump/energyJump/energyJumpFvPatchScalarField.H b/src/thermophysicalModels/basic/derivedFvPatchFields/energyJump/energyJump/energyJumpFvPatchScalarField.H
index aae2d9597b07a17adbff7b2515b7eb23b81d091e..833072ad07a475fa409adf9318fe5001cb204b93 100644
--- a/src/thermophysicalModels/basic/derivedFvPatchFields/energyJump/energyJump/energyJumpFvPatchScalarField.H
+++ b/src/thermophysicalModels/basic/derivedFvPatchFields/energyJump/energyJump/energyJumpFvPatchScalarField.H
@@ -29,23 +29,8 @@ Group
Description
This boundary condition provides an energy jump condition across a pair
- of coupled patches.
-
- \heading Patch usage
-
- \table
- Property | Description | Required | Default value
- jump | energy jump values | yes |
- \endtable
-
- Example of the boundary condition specification:
- \verbatim
- myPatch
- {
- type energyJump;
- jump uniform 100;
- }
- \endverbatim
+ of coupled patches. It is not applied directly, but is employed on-the-fly
+ when converting temperature boundary conditions into energy.
SeeAlso
Foam::fixedJumpFvPatchField
diff --git a/src/thermophysicalModels/basic/derivedFvPatchFields/energyJump/energyJumpAMI/energyJumpAMIFvPatchScalarField.H b/src/thermophysicalModels/basic/derivedFvPatchFields/energyJump/energyJumpAMI/energyJumpAMIFvPatchScalarField.H
index d35859b5a441dbf7d16b80cff1c238871c4a9bc2..e000c6b2004706e00f97533cecbb4255ff234521 100644
--- a/src/thermophysicalModels/basic/derivedFvPatchFields/energyJump/energyJumpAMI/energyJumpAMIFvPatchScalarField.H
+++ b/src/thermophysicalModels/basic/derivedFvPatchFields/energyJump/energyJumpAMI/energyJumpAMIFvPatchScalarField.H
@@ -29,26 +29,12 @@ Group
Description
This boundary condition provides an energy jump condition across a pair
- of coupled patches.
-
- \heading Patch usage
-
- \table
- Property | Description | Required | Default value
- jump | energy jump values | yes |
- \endtable
-
- Example of the boundary condition specification:
- \verbatim
- myPatch
- {
- type energyJumpAMI;
- jump uniform 100;
- }
- \endverbatim
+ of coupled patches with an arbitrary mesh interface (AMI). It is not
+ applied directly, but is employed on-the-fly when converting temperature
+ boundary conditions into energy.
SeeAlso
- Foam::fixedJumpFvPatchField
+ Foam::fixedJumpAMIFvPatchField
SourceFiles
energyJumpAMIFvPatchScalarField.C
diff --git a/src/thermophysicalModels/basic/derivedFvPatchFields/temperatureJump/uniformTemperatureJump/uniformTemperatureJumpFvPatchScalarField.H b/src/thermophysicalModels/basic/derivedFvPatchFields/temperatureJump/uniformTemperatureJump/uniformTemperatureJumpFvPatchScalarField.H
index d683d9adfb78fdd252f8c5833a5ecb31440f0474..fa58b32d5ed76a4dff985831a464ce2f6cd55660 100644
--- a/src/thermophysicalModels/basic/derivedFvPatchFields/temperatureJump/uniformTemperatureJump/uniformTemperatureJumpFvPatchScalarField.H
+++ b/src/thermophysicalModels/basic/derivedFvPatchFields/temperatureJump/uniformTemperatureJump/uniformTemperatureJumpFvPatchScalarField.H
@@ -29,7 +29,7 @@ Group
Description
This boundary condition provides a temperature jump condition across a
- coupled pair of cyclic patches when solving for energy.
+ coupled pair of cyclic patches, when solving for energy.
The jump is specified as a \c DataEntry type, to enable the use of, e.g.
contant, polynomial, table values.
@@ -39,7 +39,6 @@ Description
\table
Property | Description | Required | Default value
patchType | underlying patch type should be \c cyclic| yes |
- jump | current jump value | yes |
jumpTable | jump data, e.g. \c csvFile | yes |
\endtable
@@ -54,7 +53,7 @@ Description
}
\endverbatim
- The above example shows the use of a constant jump condition.
+ The above example shows the use of a constant jump condition of 300 K.
Note
The underlying \c patchType should be set to \c cyclic
diff --git a/src/thermophysicalModels/basic/derivedFvPatchFields/temperatureJump/uniformTemperatureJumpAMI/uniformTemperatureJumpAMIFvPatchScalarField.H b/src/thermophysicalModels/basic/derivedFvPatchFields/temperatureJump/uniformTemperatureJumpAMI/uniformTemperatureJumpAMIFvPatchScalarField.H
index 0697a3cb9724a5a916578416482b6f0192905760..2fdb6dc3853565b654356e5ceb5eb9b1cfcdc598 100644
--- a/src/thermophysicalModels/basic/derivedFvPatchFields/temperatureJump/uniformTemperatureJumpAMI/uniformTemperatureJumpAMIFvPatchScalarField.H
+++ b/src/thermophysicalModels/basic/derivedFvPatchFields/temperatureJump/uniformTemperatureJumpAMI/uniformTemperatureJumpAMIFvPatchScalarField.H
@@ -29,7 +29,8 @@ Group
Description
This boundary condition provides a temperature jump condition across a
- coupled pair of cyclic patches when solving for energy.
+ coupled pair of non-conformal cyclic patches using an arbitrary mesh
+ interface (AMI), when solving for energy.
The jump is specified as a \c DataEntry type, to enable the use of, e.g.
contant, polynomial, table values.
@@ -39,7 +40,6 @@ Description
\table
Property | Description | Required | Default value
patchType | underlying patch type should be \c cyclic| yes |
- jump | current jump value | yes |
jumpTable | jump data, e.g. \c csvFile | yes |
\endtable
@@ -54,14 +54,14 @@ Description
}
\endverbatim
- The above example shows the use of a constant jump condition.
+ The above example shows the use of a constant jump condition of 300 K.
Note
- The underlying \c patchType should be set to \c cyclic
+ The underlying \c patchType should be set to \c cyclicAMI
SeeAlso
- Foam::uniformJumpFvPatchField
- Foam::energyJumpFvPatchScalarField
+ Foam::uniformJumpAMIFvPatchField
+ Foam::energyJumpAMIFvPatchScalarField
SourceFiles
uniformTemperatureJumpAMIFvPatchScalarField.C