functionObjectLine.H 3.52 KB
Newer Older
1 2 3 4
/*---------------------------------------------------------------------------*\
  =========                 |
  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   \\    /   O peration     |
5
    \\  /    A nd           | Copyright (C) 2015-2019 OpenCFD Ltd.
6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24
     \\/     M anipulation  |
-------------------------------------------------------------------------------
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
25
    Foam::functionObjects::runTimePostPro::functionObjectLine
26 27

Description
28 29 30 31 32 33 34
    Visualisation of line data from function object output (file-based only).

    Dictionary controls
    \table
        Property    | Description                           | Required | Default
        type        | The line type: functionObjectLine     | yes |
    \endtable
35 36 37 38 39 40

SourceFiles
    functionObjectLine.C

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

41 42
#ifndef functionObjects_runTimePostPro_functionObjectLine_H
#define functionObjects_runTimePostPro_functionObjectLine_H
43 44

#include "pathline.H"
45
#include "functionObjectBase.H"
46 47 48 49 50

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

namespace Foam
{
51 52 53 54
namespace functionObjects
{
namespace runTimePostPro
{
55 56 57 58 59 60 61 62

/*---------------------------------------------------------------------------*\
                     Class functionObjectLine Declaration
\*---------------------------------------------------------------------------*/

class functionObjectLine
:
    public pathline,
63
    public functionObjectBase
64
{
65 66 67
protected:

    // Protected Data
68

69 70 71 72 73
        //- Actor
        vtkSmartPointer<vtkActor> actor_;


    // Protected Member Functions
74

75
        //- No copy construct
76
        functionObjectLine(const functionObjectLine&) = delete;
77

78
        //- No copy assignment
79
        void operator=(const functionObjectLine&) = delete;
80 81 82 83 84


public:

    //- Run-time type information
85
    TypeNameNoDebug("functionObjectLine");
86 87 88 89 90 91 92 93 94


    // Constructors

        //- Construct from dictionary
        functionObjectLine
        (
            const runTimePostProcessing& parent,
            const dictionary& dict,
95
            const HashPtrTable<Function1<vector>>& colours
96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113
        );


    //- Destructor
    virtual ~functionObjectLine();


    // Member Functions

        //- Add tube(s) to scene
        virtual void addGeometryToScene
        (
            const scalar position,
            vtkRenderer* renderer
        );

        //- Update actors
        virtual void updateActors(const scalar position);
114 115 116

        //- Clear files used to create the object(s)
        virtual bool clear();
117 118 119 120 121
};


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

122 123
} // End namespace runTimePostPro
} // End namespace functionObjects
124 125 126 127 128 129 130
} // End namespace Foam

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

#endif

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