zhyang-dev/openfoam
1
0
Fork 0
mirror of https://develop.openfoam.com/Development/openfoam.git synced 2025-11-28 03:28:01 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

ENH: adding use description in CodedSource.H

Browse Source
This commit is contained in:
Sergio Ferraris
2013-12-20 12:26:40 +00:00
parent 59921dfc5c
commit 2d529e0240
1 changed files with 69 additions and 28 deletions
Download Patch File Download Diff File Expand all files Collapse all files

97
src/fvOptions/sources/general/codedSource/CodedSource.H
View File

@ -25,44 +25,85 @@ Class
Foam::fv::codedSource
Description
Constructs on-the-fly source
Constructs on-the-fly fvOption source
The hook functions take the following arguments:
codeCorrect
(
GeometricField<Type, fvPatchField, volMesh>& fld
)
codeAddSup
(
fvMatrix<Type}>& eqn,
const label fieldI
)
setValue
(
fvMatrix<Type}>& eqn,
const label fieldI
)
where :
fld is the field in fieldNames
eqn is the fvMatrix
\heading Source usage
Example usage:
Example usage in controlDict:
\verbatim
vectorCodedSourceCoeffs
energySource
{
fieldNames (U);
redirectType ramp;
type scalarCodedSource;
codeCorrect
#{
Pout<< "**codeCorrect**" << endl;
#};
active true;
selectionMode all;
codeAddSup
#{
Pout<< "**codeAddSup**" << endl;
#};
scalarCodedSourceCoeffs
{
fieldNames (h);
redirectType sourceTime;
codeSetValue
#{
Pout<< "**codeSetValue**" << endl;
#};
codeInclude
#{
// Dummy entry. Make dependent on above to trigger recompilation
code
#{
$codeCorrect
$codeAddSup
$codeSetValue
#};
#};
codeCorrect
#{
Pout<< "**codeCorrect**" << endl;
#};
codeAddSup
#{
const Time& time = mesh().time();
const scalarField& V = mesh_.V();
scalarField& heSource = eqn.source();
heSource -= 0.1*sqr(time.value())*V;
#};
codeSetValue
#{
Pout<< "**codeSetValue**" << endl;
#};
// Dummy entry. Make dependent on above to trigger recompilation
code
#{
$codeInclude
$codeCorrect
$codeAddSup
$codeSetValue
#};
}
sourceTimeCoeffs
{
// Dummy entry
}
}
// Dummy entry
rampCoeffs
{}
\endverbatim