openfoam/src/finiteVolume/cfdTools/general/fieldSources/timeActivatedExplicitSource/TimeActivatedExplicitSource.C

/*---------------------------------------------------------------------------*\
  =========                 |
  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   \\    /   O peration     |
    \\  /    A nd           | Copyright (C) 2010-2010 OpenCFD Ltd.
     \\/     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 2 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, write to the Free Software Foundation,
    Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA

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

#include "TimeActivatedExplicitSource.H"
#include "fvMesh.H"
#include "volFields.H"

// * * * * * * * * * * * * Static Member Functions * * * * * * * * * * * * * //

template<class Type>
const Foam::wordList Foam::TimeActivatedExplicitSource<Type>::
selectionModeTypeNames_
(
    IStringStream("(points cellSet)")()
);


template<class Type>
const Foam::wordList Foam::TimeActivatedExplicitSource<Type>::
volumeModeTypeNames_
(
    IStringStream("(absolute specific)")()
);


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

template<class Type>
typename Foam::TimeActivatedExplicitSource<Type>::selectionModeType
Foam::TimeActivatedExplicitSource<Type>::wordToSelectionModeType
(
    const word& smtName
) const
{
    forAll(selectionModeTypeNames_, i)
    {
        if (smtName == selectionModeTypeNames_[i])
        {
            return selectionModeType(i);
        }
    }

    FatalErrorIn
    (
        "TimeActivatedExplicitSource<Type>::selectionModeType"
        "TimeActivatedExplicitSource<Type>::wordToSelectionModeType"
        "("
            "const word&"
        ")"
    )   << "Unknown selectionMode type " << smtName
        << ". Valid selectionMode types are:" << nl << selectionModeTypeNames_
        << exit(FatalError);

    return selectionModeType(0);
}


template<class Type>
typename Foam::TimeActivatedExplicitSource<Type>::volumeModeType
Foam::TimeActivatedExplicitSource<Type>::wordToVolumeModeType
(
    const word& vmtName
) const
{
    forAll(volumeModeTypeNames_, i)
    {
        if (vmtName == volumeModeTypeNames_[i])
        {
            return volumeModeType(i);
        }
    }

    FatalErrorIn
    (
        "TimeActivatedExplicitSource<Type>::volumeModeType"
        "TimeActivatedExplicitSource<Type>::wordToVolumeModeType(const word&)"
    )   << "Unknown volumeMode type " << vmtName
        << ". Valid volumeMode types are:" << nl << volumeModeTypeNames_
        << exit(FatalError);

    return volumeModeType(0);
}


template<class Type>
Foam::word Foam::TimeActivatedExplicitSource<Type>::selectionModeTypeToWord
(
    const selectionModeType& smtType
) const
{
    if (smtType > selectionModeTypeNames_.size())
    {
        return "UNKNOWN";
    }
    else
    {
        return selectionModeTypeNames_[smtType];
    }
}


template<class Type>
Foam::word Foam::TimeActivatedExplicitSource<Type>::volumeModeTypeToWord
(
    const volumeModeType& vmtType
) const
{
    if (vmtType > volumeModeTypeNames_.size())
    {
        return "UNKNOWN";
    }
    else
    {
        return volumeModeTypeNames_[vmtType];
    }
}


template<class Type>
void Foam::TimeActivatedExplicitSource<Type>::setSelection
(
    const dictionary& dict
)
{
    switch (selectionMode_)
    {
        case smPoints:
        {
            dict.lookup("points") >> points_;
            break;
        }
        case smCellSet:
        {
            dict.lookup("cellSet") >> cellSetName_;
            break;
        }
        default:
        {
            FatalErrorIn
            (
                "TimeActivatedExplicitSource::setSelection(const dictionary&)"
            )   << "Unknown selectionMode "
                << selectionModeTypeNames_[selectionMode_]
                << ". Valid selectionMode types are" << selectionModeTypeNames_
                << exit(FatalError);
        }
    }
}


template<class Type>
void Foam::TimeActivatedExplicitSource<Type>::setFieldData
(
    const dictionary& dict,
    const wordList& fieldNames
)
{
    dict.lookup("fieldData") >> fieldData_;
    labelList localFieldIds(fieldData_.size(), -1);
    forAll(fieldNames, i)
    {
        forAll(fieldData_, j)
        {
            const word& fdName = fieldData_[j].first();
            if (fdName == fieldNames[i])
            {
                fieldIds_[i] = j;
                localFieldIds[j] = i;
                break;
            }
        }
    }
    forAll(localFieldIds, i)
    {
        if (localFieldIds[i] < 0)
        {
            FatalErrorIn
            (
                "TimeActivatedExplicitSource<Type>::setFieldData"
                "("
                    "const dictionary&, "
                    "const wordList&"
                ")"
            )   << "Field " << fieldData_[i].first() << " not found in "
                << "field list. Available fields are: " << nl << fieldNames
                << exit(FatalError);
        }
    }
}


template<class Type>
void Foam::TimeActivatedExplicitSource<Type>::setCellSet()
{
    switch (selectionMode_)
    {
        case smPoints:
        {
            labelHashSet cellOwners;
            forAll(points_, i)
            {
                label cellI = mesh_.findCell(points_[i]);
                if (cellI >= 0)
                {
                    cellOwners.insert(cellI);
                }
            }
            cellsPtr_.reset(new cellSet(mesh_, "points", cellOwners));

            break;
        }
        case smCellSet:
        {
            cellsPtr_.reset(new cellSet(mesh_, cellSetName_));

            break;
        }
        default:
        {
            FatalErrorIn("TimeActivatedExplicitSource::setCellIds()")
                << "Unknown selectionMode "
                << selectionModeTypeNames_[selectionMode_]
                << ". Valid selectionMode types are" << selectionModeTypeNames_
                << exit(FatalError);
        }
    }

    const cellSet& cSet = cellsPtr_();

    // Set volume normalisation
    V_ = scalarField(cSet.size(), 1.0);
    if (volumeMode_ == vmAbsolute)
    {
        label i = 0;
        forAllConstIter(cellSet, cSet, iter)
        {
            V_[i++] = mesh_.V()[iter.key()];
        }
    }

    Info<< incrIndent << indent << name_ << ": selected "
        << returnReduce(cSet.size(), sumOp<label>())
        << " cell(s)" << nl << decrIndent << endl;
}


// * * * * * * * * * * * * * * * * Constructors  * * * * * * * * * * * * * * //

template<class Type>
Foam::TimeActivatedExplicitSource<Type>::TimeActivatedExplicitSource
(
    const word& name,
    const dictionary& dict,
    const fvMesh& mesh,
    const wordList& fieldNames
)
:
    name_(name),
    mesh_(mesh),
    active_(dict.lookup("active")),
    timeStart_(readScalar(dict.lookup("timeStart"))),
    duration_(readScalar(dict.lookup("duration"))),
    volumeMode_(wordToVolumeModeType(dict.lookup("volumeMode"))),
    selectionMode_(wordToSelectionModeType(dict.lookup("selectionMode"))),
    points_(),
    cellSetName_("none"),
    V_(),
    cellsPtr_(),
    fieldData_(),
    fieldIds_(fieldNames.size(), -1)
{
    setSelection(dict);

    if (fieldNames.size() == 1)
    {
        fieldData_.setSize(1);
        fieldData_[0].first() = fieldNames[0];
        dict.lookup("fieldData") >> fieldData_[0].second();
        fieldIds_[0] = 0;
    }
    else
    {
        setFieldData(dict, fieldNames);
    }

    setCellSet();
}


template<class Type>
void Foam::TimeActivatedExplicitSource<Type>::addToField
(
    DimensionedField<Type, volMesh>& Su,
    const label fieldI
)
{
    const label fid = fieldIds_[fieldI];

    if
    (
        active_
     && (fid >= 0)
     && (mesh_.time().value() >= timeStart_)
     && (mesh_.time().value() <= timeEnd())
    )
    {
        // Update the cell set if the mesh is changing
        if (mesh_.changing())
        {
            setCellSet();
        }

        const cellSet& cSet = cellsPtr_();

        label i = 0;
        forAllConstIter(cellSet, cSet, iter)
        {
            Su[iter.key()] = fieldData_[fid].second()/V_[i++];
        }
    }
}


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