catalystFunctionObject.H 5.65 KB
Newer Older
1 2 3 4 5
/*---------------------------------------------------------------------------*\
  =========                 |
  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   \\    /   O peration     |
    \\  /    A nd           | Copyright (C) 2018 OpenCFD Ltd.
6 7 8
     \\/     M anipulation  |
-------------------------------------------------------------------------------
                            | Copyright (C) 2018 CINECA
9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32
-------------------------------------------------------------------------------
License
    This file is part of OpenFOAM.

    OpenFOAM is free software: you can redistribute it and/or modify it
    under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

    OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
    ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
    FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
    for more details.

    You should have received a copy of the GNU General Public License
    along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.

Class
    Foam::functionObjects::catalystFunctionObject

Group
    grpUtilitiesFunctionObjects

Description
33
    A Paraview Catalyst adaptor for OpenFOAM.
34 35 36 37 38 39 40 41 42 43

    Example of function object specification:
    \verbatim
    catalyst
    {
        type            catalyst;
        libs            ("libcatalystFoam.so");
        executeControl  timeStep;
        executeInterval 1;

44 45
        scripts         ( ... );

46 47
        inputs
        {
48 49 50 51 52 53 54 55 56 57 58 59
            input1
            {
                type    default;
                regions (".*solid" );
                fields  (U p);
            }
            input2
            {
                type    cloud;
                cloud   someCloud;
                fields  ( T U p rho );
            }
60 61 62 63 64 65
        }
    }
    \endverbatim

Usage
    \table
66 67 68 69 70 71 72
        Property    | Description                       | Required | Default
        type        | catalyst                          | yes   |
        log         | report extra information          | no    | false
        scripts     | Python pipeline scripts           | yes   |
        inputs      | dictionary of catalyst inputs     | yes   |
        outputDir   | the output directory          | no    | "\<case\>/insitu"
        mkdir       | optional directory to create      | no    |
73 74 75
    \endtable

Note
76
    The execution frequency can be defined by both the functionObject and
77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134
    by the Catalyst pipeline.

See also
    Foam::functionObjects::functionObject
    Foam::functionObjects::fvMeshFunctionObject
    Foam::functionObjects::timeControl
    Foam::catalyst::coprocess
    Foam::catalyst::cloudInput
    Foam::catalyst::faMeshInput
    Foam::catalyst::fvMeshInput

SourceFiles
    catalystFunctionObject.C
    catalystFunctionObjectTemplates.C

\*---------------------------------------------------------------------------*/

#ifndef functionObjects_catalystFunctionObject_H
#define functionObjects_catalystFunctionObject_H

#include "className.H"
#include "wordList.H"
#include "stringList.H"
#include "polyMesh.H"
#include "PtrList.H"
#include "functionObject.H"
#include "catalystCoprocess.H"
#include "catalystInput.H"

// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //

namespace Foam
{
namespace functionObjects
{

/*---------------------------------------------------------------------------*\
                   Class catalystFunctionObject Declaration
\*---------------------------------------------------------------------------*/

class catalystFunctionObject
:
    public functionObject
{
    // Private data

        //- Reference to the time database
        const Time& time_;

        //- The output directory
        fileName outputDir_;

        //- Python scripts for the catalyst pipeline
        stringList scripts_;

        //- The catalyst coprocess
        autoPtr<catalyst::coprocess> adaptor_;

135
        //- Pointers to the requested catalyst inputs
136 137 138 139 140 141 142 143 144 145 146
        PtrList<catalyst::catalystInput> inputs_;


    // Private Member Functions

        //- No copy construct
        catalystFunctionObject(const catalystFunctionObject&) = delete;

        //- No copy assignment
        void operator=(const catalystFunctionObject&) = delete;

147

148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207
public:

    // Static Methods

        //- Expand strings as filenames, retaining only those that exist
        static label expand(List<string>& scripts, const dictionary& dict);


    //- Runtime type information
    TypeName("catalyst");


    // Constructors

        //- Construct from Time and dictionary
        catalystFunctionObject
        (
            const word& name,
            const Time& runTime,
            const dictionary& dict
        );


    //- Destructor
    virtual ~catalystFunctionObject();


    // Member Functions

        //- Read the specification
        virtual bool read(const dictionary& dict);

        //- Execute catalyst pipelines
        virtual bool execute();

        //- Write - does nothing
        virtual bool write();

        //- On end - provide feedback about disconnecting from catatyst.
        virtual bool end();

        //- Update for changes of mesh
        virtual void updateMesh(const mapPolyMesh& mpm);

        //- Update for mesh point-motion
        virtual void movePoints(const polyMesh& mesh);

};


// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //

} // End namespace functionObjects
} // End namespace Foam

// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //

#endif

// ************************************************************************* //