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

Description
30 31 32 33 34 35 36
    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
37 38 39 40 41 42

SourceFiles
    functionObjectLine.C

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

43 44
#ifndef functionObjects_runTimePostPro_functionObjectLine_H
#define functionObjects_runTimePostPro_functionObjectLine_H
45 46

#include "pathline.H"
47
#include "functionObjectBase.H"
48 49 50 51 52

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

namespace Foam
{
53 54 55 56
namespace functionObjects
{
namespace runTimePostPro
{
57 58 59 60 61 62 63 64

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

class functionObjectLine
:
    public pathline,
65
    public functionObjectBase
66
{
67 68 69
protected:

    // Protected Data
70

71 72 73 74 75
        //- Actor
        vtkSmartPointer<vtkActor> actor_;


    // Protected Member Functions
76

77
        //- No copy construct
78
        functionObjectLine(const functionObjectLine&) = delete;
79

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


public:

86
    //- Declare type-name, virtual type (without debug switch)
87
    TypeNameNoDebug("functionObjectLine");
88 89 90 91 92 93 94 95 96


    // Constructors

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


    //- 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);
116 117 118

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


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

124 125
} // End namespace runTimePostPro
} // End namespace functionObjects
126 127 128 129 130 131 132
} // End namespace Foam

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

#endif

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