Skip to content
Snippets Groups Projects
FieldFunctionsM.H 16.4 KiB
Newer Older
  • Learn to ignore specific revisions
  • /*---------------------------------------------------------------------------*\
      =========                 |
      \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
       \\    /   O peration     |
    
    OpenFOAM bot's avatar
    OpenFOAM bot committed
        \\  /    A nd           | www.openfoam.com
    
         \\/     M anipulation  |
    
    -------------------------------------------------------------------------------
    
    OpenFOAM bot's avatar
    OpenFOAM bot committed
        Copyright (C) 2011-2016 OpenFOAM Foundation
    
    -------------------------------------------------------------------------------
    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/>.
    
    
    Description
        High performance macro functions for Field\<Type\> algebra.  These expand
        using either array element access (for vector machines) or pointer
        dereferencing for scalar machines as appropriate.
    
    \*---------------------------------------------------------------------------*/
    
    // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
    
    
    #define UNARY_FUNCTION(ReturnType, Type1, Func)                                \
                                                                                   \
    TEMPLATE                                                                       \
    void Func(Field<ReturnType>& res, const UList<Type1>& f);                      \
    TEMPLATE                                                                       \
    tmp<Field<ReturnType>> Func(const UList<Type1>& f);                            \
    TEMPLATE                                                                       \
    
    tmp<Field<ReturnType>> Func(const tmp<Field<Type1>>& tf);
    
    
    
    // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
    
    
    #define UNARY_OPERATOR(ReturnType, Type1, Op, OpFunc)                          \
                                                                                   \
    TEMPLATE                                                                       \
    void OpFunc(Field<ReturnType>& res, const UList<Type1>& f);                    \
    TEMPLATE                                                                       \
    tmp<Field<ReturnType>> operator Op(const UList<Type1>& f);                     \
    TEMPLATE                                                                       \
    
    tmp<Field<ReturnType>> operator Op(const tmp<Field<Type1>>& tf);
    
    
    
    // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
    
    
    #define BINARY_FUNCTION(ReturnType, Type1, Type2, Func)                        \
                                                                                   \
    TEMPLATE                                                                       \
    void Func                                                                      \
    (                                                                              \
        Field<ReturnType>& f,                                                      \
        const UList<Type1>& f1,                                                    \
        const UList<Type2>& f2                                                     \
    );                                                                             \
                                                                                   \
    TEMPLATE                                                                       \
    tmp<Field<ReturnType>> Func                                                    \
    (                                                                              \
        const UList<Type1>& f1,                                                    \
        const UList<Type2>& f2                                                     \
    );                                                                             \
                                                                                   \
    TEMPLATE                                                                       \
    tmp<Field<ReturnType>> Func                                                    \
    (                                                                              \
        const UList<Type1>& f1,                                                    \
        const tmp<Field<Type2>>& tf2                                               \
    );                                                                             \
                                                                                   \
    TEMPLATE                                                                       \
    tmp<Field<ReturnType>> Func                                                    \
    (                                                                              \
        const tmp<Field<Type1>>& tf1,                                              \
        const UList<Type2>& f2                                                     \
    );                                                                             \
                                                                                   \
    TEMPLATE                                                                       \
    tmp<Field<ReturnType>> Func                                                    \
    (                                                                              \
        const tmp<Field<Type1>>& tf1,                                              \
        const tmp<Field<Type2>>& tf2                                               \
    
    );
    
    
    // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
    
    
    #define BINARY_TYPE_FUNCTION_SF(ReturnType, Type1, Type2, Func)                \
                                                                                   \
    TEMPLATE                                                                       \
    void Func                                                                      \
    (                                                                              \
        Field<ReturnType>& f,                                                      \
        const Type1& s1,                                                           \
        const UList<Type2>& f2                                                     \
    );                                                                             \
                                                                                   \
    TEMPLATE                                                                       \
    tmp<Field<ReturnType>> Func                                                    \
    (                                                                              \
        const Type1& s1,                                                           \
        const UList<Type2>& f2                                                     \
    );                                                                             \
                                                                                   \
    TEMPLATE                                                                       \
    tmp<Field<ReturnType>> Func                                                    \
    (                                                                              \
        const Type1& s1,                                                           \
        const tmp<Field<Type2>>& tf2                                               \
    
    #define BINARY_TYPE_FUNCTION_FS(ReturnType, Type1, Type2, Func)                \
                                                                                   \
    TEMPLATE                                                                       \
    void Func                                                                      \
    (                                                                              \
        Field<ReturnType>& f,                                                      \
        const UList<Type1>& f1,                                                    \
        const Type2& s2                                                            \
    );                                                                             \
                                                                                   \
    TEMPLATE                                                                       \
    tmp<Field<ReturnType>> Func                                                    \
    (                                                                              \
        const UList<Type1>& f1,                                                    \
        const Type2& s2                                                            \
    );                                                                             \
                                                                                   \
    TEMPLATE                                                                       \
    tmp<Field<ReturnType>> Func                                                    \
    (                                                                              \
        const tmp<Field<Type1>>& tf1,                                              \
        const Type2& s2                                                            \
    
    #define BINARY_TYPE_FUNCTION(ReturnType, Type1, Type2, Func)                   \
        BINARY_TYPE_FUNCTION_SF(ReturnType, Type1, Type2, Func)                    \
    
        BINARY_TYPE_FUNCTION_FS(ReturnType, Type1, Type2, Func)
    
    
    // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
    
    
    #define BINARY_OPERATOR(ReturnType, Type1, Type2, Op, OpFunc)                  \
                                                                                   \
    TEMPLATE                                                                       \
    void OpFunc                                                                    \
    (                                                                              \
        Field<ReturnType>& f,                                                      \
        const UList<Type1>& f1,                                                    \
        const UList<Type2>& f2                                                     \
    );                                                                             \
                                                                                   \
    TEMPLATE                                                                       \
    tmp<Field<ReturnType>> operator Op                                             \
    (                                                                              \
        const UList<Type1>& f1,                                                    \
        const UList<Type2>& f2                                                     \
    );                                                                             \
                                                                                   \
    TEMPLATE                                                                       \
    tmp<Field<ReturnType>> operator Op                                             \
    (                                                                              \
        const UList<Type1>& f1,                                                    \
        const tmp<Field<Type2>>& tf2                                               \
    );                                                                             \
                                                                                   \
    TEMPLATE                                                                       \
    tmp<Field<ReturnType>> operator Op                                             \
    (                                                                              \
        const tmp<Field<Type1>>& tf1,                                              \
        const UList<Type2>& f2                                                     \
    );                                                                             \
                                                                                   \
    TEMPLATE                                                                       \
    tmp<Field<ReturnType>> operator Op                                             \
    (                                                                              \
        const tmp<Field<Type1>>& tf1,                                              \
        const tmp<Field<Type2>>& tf2                                               \
    
    );
    
    
    // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
    
    
    #define BINARY_TYPE_OPERATOR_SF(ReturnType, Type1, Type2, Op, OpFunc)          \
                                                                                   \
    TEMPLATE                                                                       \
    void OpFunc                                                                    \
    (                                                                              \
        Field<ReturnType>& f,                                                      \
        const Type1& s1,                                                           \
        const UList<Type2>& f2                                                     \
    );                                                                             \
                                                                                   \
    TEMPLATE                                                                       \
    tmp<Field<ReturnType>> operator Op                                             \
    (                                                                              \
        const Type1& s1,                                                           \
        const UList<Type2>& f2                                                     \
    );                                                                             \
                                                                                   \
    TEMPLATE                                                                       \
    tmp<Field<ReturnType>> operator Op                                             \
    (                                                                              \
        const Type1& s1,                                                           \
        const tmp<Field<Type2>>& tf2                                               \
    
    #define BINARY_TYPE_OPERATOR_FS(ReturnType, Type1, Type2, Op, OpFunc)          \
                                                                                   \
    TEMPLATE                                                                       \
    void OpFunc                                                                    \
    (                                                                              \
        Field<ReturnType>& f,                                                      \
        const UList<Type1>& f1,                                                    \
        const Type2& s2                                                            \
    );                                                                             \
                                                                                   \
    TEMPLATE                                                                       \
    tmp<Field<ReturnType>> operator Op                                             \
    (                                                                              \
        const UList<Type1>& f1,                                                    \
        const Type2& s2                                                            \
    );                                                                             \
                                                                                   \
    TEMPLATE                                                                       \
    tmp<Field<ReturnType>> operator Op                                             \
    (                                                                              \
        const tmp<Field<Type1>>& tf1,                                              \
        const Type2& s2                                                            \
    
    #define BINARY_TYPE_OPERATOR(ReturnType, Type1, Type2, Op, OpFunc)             \
        BINARY_TYPE_OPERATOR_SF(ReturnType, Type1, Type2, Op, OpFunc)              \
    
        BINARY_TYPE_OPERATOR_FS(ReturnType, Type1, Type2, Op, OpFunc)
    
    
    // ************************************************************************* //