View source for Contrib/reconstruct-interpolate-fields

This page is a ''verbatim'' copy of the [https://github.com/wyldckat/reconstruct-interpolate-fields/wiki wiki page] resident in the project [https://github.com/wyldckat/reconstruct-interpolate-fields reconstruct-interpolate-fields at wyldckat@github].
Feel free to improve this page or even collaborate directly with that small project, either with code or wiki edits. - [[User:Wyldckat|Wyldckat]] 01:24, 15 July 2012 (CEST)

<br />
__FORCETOC__

= Introduction =
This small project, designed for being used with [http://www.openfoam.org OpenFOAM], is both a small educational kit about <code>fvc::interpolate</code> and <code>fvc::reconstruct</code>, as well as a convenient kit of utilities for using those two methods for field interpolations on face to/from cell centres.

So far, the two utilities available are meant only for using at the post-processing stage and it's advisable to use them on fields that were written in binary form. Said ''binary form'' is explained in OpenFOAM's User Guide, in the section about <code>controlDict</code>.

If you have trouble/problems using this ''toolkit'', you can use either one of the following forums:
* The thread created for this at CFD-Online: [http://www.cfd-online.com/Forums/openfoam-post-processing/104747-small-toolkit-reconstructing-interpolating-fields.html Small toolkit for reconstructing and interpolating fields].
* This project's [https://github.com/wyldckat/reconstruct-interpolate-fields/issues Issues tracker].

= Installation =
How to get and build:
<pre>
git clone git://github.com/wyldckat/reconstruct-interpolate-fields.git
cd reconstruct-interpolate-fields
wmake all
</pre>

If you don't have Git installed, you can use the ZIP option shown in the project page: [https://github.com/wyldckat/reconstruct-interpolate-fields reconstruct-interpolate-fields at wyldckat@github]

= How to use =

== interpolateVolumeField ==
<code>interpolateVolumeField</code> can interpolate volume fields to surface fields. More specifically, it will interpolate the fields that exist in the cell centres onto the face centres. This operation is only done for the following field interpolations:
* Interpolate <code>volScalarField</code> to <code>surfaceScalarField</code>.
* Interpolate <code>volVectorField</code> to <code>surfaceVectorField</code>.

Note: It can be extended for the operation of <code>volTensorField</code> to <code>surfaceTensorField</code>, as well as accepting a list of fields for interpolation. This is left as an exercise to the reader, so feel free to ''fork'' this project. And you can do a ''pull request'' when you feel like to share your modifications with this project. For more about about forking and pull requests read the [https://help.github.com/ GitHub Help].

As for using this utility, you can run in the following ways:
* Interpolate one scalar field for all time instances: <pre>interpolateVolumeField -scalar p pInterpolated</pre>
* Interpolate one vector field for all time instances: <pre>interpolateVolumeField -vector U Uinterpolated</pre>
* Interpolate one scalar field for the latest time only: <pre>interpolateVolumeField -scalar p pInterpolated -latestTime</pre>
* Interpolate one vector field for the latest time only: <pre>interpolateVolumeField -vector U Uinterpolated -latestTime</pre>

For more options, run:
<pre>interpolateVolumeField -help</pre>

== reconstructSurfaceField ==
<code>reconstructSurfaceField</code> can reconstruct surface fields back to volume fields. More specifically, it will interpolate the fields that exist in the face centres onto the cell centres. 

'''But''' this operation is not the opposite done by <code>interpolateVolumeField</code>, because <code>fvc::reconstruct</code> was designed for reconstructing the field from the operation of <code>fvc::interpolate(volVectorField) & Mesh.Sf()</code>. In other words, the reconstruction operation will created a vector from the 3 main directions of face scalar values or a tensor from the same 3 main directions of face vector values.

Which means that this operation is only done to the following fields:
* Reconstruct <code>volVectorField</code> from <code>surfaceScalarField</code>.
* Reconstruct <code>volTensorField</code> from <code>surfaceVectorField</code>.

Note: It might be possible to interpolate surface fields to volume fields, but this was not studied for this project. This is left as an exercise to the reader, so feel free to ''fork'' this project. And you can do a ''pull request'' when you feel like to share your modifications with this project. For more about about forking and pull requests read the [https://help.github.com/ GitHub Help].

As for using this utility, you can run in the following ways:
* Reconstruct one surface scalar to volume vector field for all time instances: <pre>reconstructSurfaceField -scalar phi phiCells</pre>
* Reconstruct one surface vector to volume tensor field for all time instances: <pre>reconstructSurfaceField -vector phiUp phiUpCells</pre>
* Reconstruct one surface scalar to volume vector field for the latest time only: <pre>reconstructSurfaceField -scalar phi phiCells -latestTime</pre>
* Reconstruct one surface vector to volume tensor field for the latest time only: <pre>reconstructSurfaceField -vector phiUp phiUpCells -latestTime</pre>

For more options, run:
<pre>reconstructSurfaceField -help</pre>

= Viewing and exporting results =
For viewing and exporting surface fields to another format:
# Export to VTK: <pre>foamToVTK -surfaceFields</pre> Note: This will export '''all''' surface fields to VTK, so no need to select which ones to export.
# Open in ParaView one or more files <code>VTK/surfaceFields/surfaceFields_*.vtk</code>.
# Then on ParaView, with one of the <code>surfaceFields_*.vtk</code> selected:
#* To view, apply the <code>Glyph</code> filter. Use <code>Sphere</code> glyph on scalars and <code>Arrow</code> on vectors.
#* To export: choose on the menu <code>File -> Save Data</code> then save as CSV. It will ask the mode of export, for which you can choose the default option.

<br />
For viewing volume fields, they will appear on the list of fields to import on ParaView, in the <code>Object Inspector</code> widget, or simply be exported as any other volume field.