fieldsExpressionTemplates.C

Go to the documentation of this file.

/*---------------------------------------------------------------------------*\
  =========                 |
  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   \\    /   O peration     | Website:  https://openfoam.org
    \\  /    A nd           | Copyright (C) 2016-2021 OpenFOAM Foundation
     \\/     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/>.

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

#include "fieldsExpression.H"
#include "volFields.H"
#include "surfaceFields.H"

// * * * * * * * * * * * * Protected Member Functions  * * * * * * * * * * * //

template
<
    template<class> class GeoField,
    template<class ...> class Op,
    class TypeA,
    class TypeB,
    class Enable
>
bool Foam::functionObjects::fieldsExpression::opAndStore
(
    const GeoField<TypeA>& a,
    const GeoField<TypeB>& b
)
{
    return store(resultName_, Op<GeoField<TypeA>, GeoField<TypeB>>()(a, b));
}


template
<
    template<class> class GeoField,
    template<class ...> class Op,
    class ... Args
>
bool Foam::functionObjects::fieldsExpression::opAndStore
(
    const Args& ...
)
{
    return false;
}


template
<
    template<class> class GeoField,
    template<class ...> class Op,
    class TypeA,
    class TypeB
>
bool Foam::functionObjects::fieldsExpression::foldAB(const label i)
{
    if
    (
        i == 0
     && foundObject<GeoField<TypeA>>(fieldNames_[0])
    )
    {
        clearObject(resultName_);
        return store
        (
            resultName_,
            lookupObject<GeoField<TypeA>>(fieldNames_[0]).clone()
        );
    }

    if
    (
        i > 0
     && foundObject<GeoField<TypeA>>(resultName_)
     && foundObject<GeoField<TypeB>>(fieldNames_[i])
    )
    {
        tmp<GeoField<TypeA>> a =
            lookupObject<GeoField<TypeA>>(resultName_).clone();
        const GeoField<TypeB>& b =
            lookupObject<GeoField<TypeB>>(fieldNames_[i]);

        clearObject(resultName_);
        return opAndStore<GeoField, Op>(a(), b);
    }

    return false;
}


template
<
    template<class> class GeoField,
    template<class ...> class Op,
    class TypeA
>
bool Foam::functionObjects::fieldsExpression::foldA(const label i)
{
    bool success = false;

    #define processType(Type, none) \
        success = success || foldAB<GeoField, Op, TypeA, Type>(i);
    FOR_ALL_FIELD_TYPES(processType);
    #undef processType

    return success;
}


template<template<class> class GeoField, template<class ...> class Op>
bool Foam::functionObjects::fieldsExpression::fold(const label i)
{
    bool success = false;

    #define processType(Type, none) \
        success = success || foldA<GeoField, Op, Type>(i);
    FOR_ALL_FIELD_TYPES(processType);
    #undef processType

    return success;
}


template<template<class> class GeoField, template<class ...> class Op>
bool Foam::functionObjects::fieldsExpression::calcGeoFieldOp()
{
    forAll(fieldNames_, i)
    {
        if (!fold<GeoField, Op>(i))
        {
            return false;
        }
    }

    return true;
}


template<template<class ...> class Op>
bool Foam::functionObjects::fieldsExpression::calcOp()
{
    return
        calcGeoFieldOp<VolField, Op>()
     || calcGeoFieldOp<SurfaceField, Op>();
}


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