[NotOverUnderated]

Hello

In OpenFOAM, is there any way how can I add comments to vol{Vector,Scalar,...}Field from the code?

Say I have created a variable:

volVectorField X
(
  IOobject
  (
     "X",
     runTime().timeName(),
     mesh,
     IOobject::NO_READ,
     IOobject::AUTO_WRITE
  )
)

The output of this is the usual OpenFOAM files: a header, dimensions, internalField, boundaryField, etc.

Here is an example of the output I expect:

/*--------------------------------*- C++ -*----------------------------------*\
  =========                 |
  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   \\    /   O peration     | Website:  https://openfoam.com
    \\  /    A nd           | Version:  2006
     \\/     M anipulation  |
\*---------------------------------------------------------------------------*/
FoamFile
{
    version         2;
    format          binary;
    class           volVectorField;
    location        "0.1";
    object          X;
}

dimensions      [ 0 1 -1 0 0 0 0 ];

// >>> I  want to add a comment here <<<
internalField   uniform (15 3.0 -5.0 );

boundaryField
{
    ...
    ...
}

I know that I can add that manually when the program finishes. But is it possible to add the comment from the code itself so the output field will contain that comment in every time folder?

Thank you

[Tobermory]

To be honest, this is not trivial (due to the way that OF handles IOobjects, the write action is a pretty low level functionality, buried deep in the class hierarchy; you'd need to generate your own flavour of IOobject, with an additional constructor to take the comment, and then update a whole buch of other buried, connected stuff as well ...).

I would strongly recommend trying to do it another way, e.g. use a functionObject to run a sed command on the file when it is written, to insert the comment ... or even simpler just run a script at the end of the run to add the comment to all the save files. If you want it done on the fly, you could write the script to keep checking for new, unchanged save files, and when it finds one pause (to allow tge write to complete) and then update ... you can then run this script alongside your real run.

Probably not what you wanted to hear, but good luck anyway.

[olesen]

Can second what Tobermory says. You can easily drop in some regular comments in the input, or even drop them in as input entries. For example

comment1  "This is an internalField";


internalFIeld ....

These will survive things like foamDictionary expansion, much like how you see files being assembled with various "#include" statements. However, when the volume field is written out, it only knows about its dimensions, internalField, boundaryField and each of the boundary condition types know how to write out their content. Since this content has been generated from OpenFOAM itself, there is no direct connection with your original input file whatsoever.