AMIWeights.H 5.43 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) 2018-2020 OpenCFD Ltd.
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::AMIWeights

Group
    grpFieldFunctionObjects

Description
33 34 35 36 37 38 39 40 41 42 43 44 45 46
    Computes the min/max/average weights of arbitrary mesh interface (AMI)
    patches, and optionally reports to a text file or writes VTK surfaces of
    the sum of the weights and mask fields for arbitrarily coupled mesh
    interface (ACMI) patches.

    Operands:
    \table
      Operand           | Type           | Location
      input             | -              | -
      output file       | dat            | $POST/\<file\>
      output field      | vtp            | $POST/\<AMINames\>_{src,tgt}.vtp
    \endtable

    where \c $POST=$FOAM_CASE/postProcessing/\<FO\>/\<time\>.
47 48

Usage
49
    Minimal example by using \c system/controlDict.functions:
50 51 52
    \verbatim
    AMIWeights1
    {
53
        // Mandatory entries (unmodifiable)
54
        type        AMIWeights;
55
        libs        (fieldFunctionObjects);
56 57 58 59 60 61

        // Mandatory entries (runtime modifiable)
        writeFields false;

        // Optional (inherited) entries
        ...
62 63 64
    }
    \endverbatim

65
    where the entries mean:
66
    \table
67 68 69 70
      Property     | Description                        | Type | Req'd | Dflt
      type         | Type name: AMIWeights              | word |  yes  | -
      libs         | Library name: fieldFunctionObjects | word |  yes  | -
      writeFields  | Write weights as VTK fields        | bool |  yes  | -
71 72
    \endtable

73 74 75 76 77 78 79 80
    The inherited entries are elaborated in:
     - \link functionObject.H \endlink
     - \link writeFile.H \endlink

    Minimal example by using the \c postProcess utility:
    \verbatim
        postProcess -func AMIWeights
    \endverbatim
81 82

See also
83 84 85 86
    - Foam::functionObject
    - Foam::functionObjects::fvMeshFunctionObject
    - Foam::functionObjects::writeFile
    - ExtendedCodeGuide::functionObjects::field::AMIWeights
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

SourceFiles
    AMIWeights.C
    AMIWeightsTemplates.C

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

#ifndef functionObjects_AMIWeights_H
#define functionObjects_AMIWeights_H

#include "fvMeshFunctionObject.H"
#include "writeFile.H"
#include "cyclicAMIPolyPatch.H"

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

namespace Foam
{
namespace functionObjects
{

/*---------------------------------------------------------------------------*\
                         Class AMIWeights Declaration
\*---------------------------------------------------------------------------*/

class AMIWeights
:
    public fvMeshFunctionObject,
    public writeFile
{
protected:

119
    // Protected Data
120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135

        //- Flag to write AMI fields (as VTK files)
        bool writeFields_;

        //- List of AMI patch IDs
        labelList patchIDs_;


    // Protected Member Functions

        //- Output file header information
        virtual void writeFileHeader(Ostream& os);

        //- Helper function to report patch information
        virtual void reportPatch(const cyclicAMIPolyPatch& pp);

136
        //- Write weight field
137 138 139 140 141 142 143
        void writeWeightField
        (
            const cyclicAMIPolyPatch& cpp,
            const scalarField& weightSum,
            const word& side
        ) const;

144
        //- Write weight fields if writeFields=true
145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163
        void writeWeightFields(const cyclicAMIPolyPatch& cpp) const;


public:

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


    // Constructors

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

164 165 166 167 168 169
        //- No copy construct
        AMIWeights(const AMIWeights&) = delete;

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

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

    //- Destructor
    virtual ~AMIWeights() = default;


    // Member Functions

        //- Read the field min/max data
        virtual bool read(const dictionary&);

        //- Execute, currently does nothing
        virtual bool execute();

        //- Write the AMIWeights
        virtual bool write();
};


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

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

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

#endif

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