semiImplicitSource.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) 2011-2020 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 "semiImplicitSource.H"
#include "fvMesh.H"
#include "fvMatrices.H"
#include "fvmSup.H"
#include "addToRunTimeSelectionTable.H"

// * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //

namespace Foam
{
    namespace fv
    {
        defineTypeNameAndDebug(semiImplicitSource, 0);

        addToRunTimeSelectionTable
        (
            cellSetOption,
            semiImplicitSource,
            dictionary
        );
    }

    template<>
    const char* NamedEnum<fv::semiImplicitSource::volumeMode, 2>::names[] =
    {
        "absolute",
        "specific"
    };
}

const Foam::NamedEnum<Foam::fv::semiImplicitSource::volumeMode, 2>
    Foam::fv::semiImplicitSource::volumeModeNames_;


// * * * * * * * * * * * ** Private Member Functions  ** * * * * * * * * * * //

template<class Type>
void Foam::fv::semiImplicitSource::addSupType
(
    fvMatrix<Type>& eqn,
    const label fieldi
)
{
    if (debug)
    {
        Info<< "semiImplicitSource<" << pTraits<Type>::typeName
            << ">::addSup for source " << name_ << endl;
    }

    const scalar t = mesh_.time().value();

    const GeometricField<Type, fvPatchField, volMesh>& psi = eqn.psi();

    typename GeometricField<Type, fvPatchField, volMesh>::Internal Su
    (
        IOobject
        (
            name_ + fieldNames_[fieldi] + "Su",
            mesh_.time().timeName(),
            mesh_,
            IOobject::NO_READ,
            IOobject::NO_WRITE
        ),
        mesh_,
        dimensioned<Type>
        (
            "zero",
            eqn.dimensions()/dimVolume,
            Zero
        ),
        false
    );

    // Explicit source function for the field
    UIndirectList<Type>(Su, cells_) = fieldSu_[fieldi].value<Type>(t)/VDash_;

    volScalarField::Internal Sp
    (
        IOobject
        (
            name_ + fieldNames_[fieldi] + "Sp",
            mesh_.time().timeName(),
            mesh_,
            IOobject::NO_READ,
            IOobject::NO_WRITE
        ),
        mesh_,
        dimensioned<scalar>
        (
            "zero",
            Su.dimensions()/psi.dimensions(),
            0
        ),
        false
    );

    // Implicit source function for the field
    UIndirectList<scalar>(Sp, cells_) = fieldSp_[fieldi].value(t)/VDash_;

    eqn += Su + fvm::SuSp(Sp, psi);
}


template<class Type>
void Foam::fv::semiImplicitSource::addSupType
(
    const volScalarField& rho,
    fvMatrix<Type>& eqn,
    const label fieldi
)
{
    if (debug)
    {
        Info<< "semiImplicitSource<" << pTraits<Type>::typeName
            << ">::addSup for source " << name_ << endl;
    }

    return this->addSup(eqn, fieldi);
}


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

Foam::fv::semiImplicitSource::semiImplicitSource
(
    const word& name,
    const word& modelType,
    const dictionary& dict,
    const fvMesh& mesh
)
:
    cellSetOption(name, modelType, dict, mesh),
    volumeMode_(volumeMode::absolute),
    VDash_(1)
{
    read(dict);
}


// * * * * * * * * * * * * * * * * Destructor  * * * * * * * * * * * * * * * //

Foam::fv::semiImplicitSource::~semiImplicitSource()
{}


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

void Foam::fv::semiImplicitSource::addSup
(
    fvMatrix<scalar>& eqn,
    const label fieldi
)
{
    addSupType(eqn, fieldi);
}


void Foam::fv::semiImplicitSource::addSup
(
    fvMatrix<vector>& eqn,
    const label fieldi
)
{
    addSupType(eqn, fieldi);
}


void Foam::fv::semiImplicitSource::addSup
(
    fvMatrix<symmTensor>& eqn,
    const label fieldi
)
{
    addSupType(eqn, fieldi);
}


void Foam::fv::semiImplicitSource::addSup
(
    fvMatrix<sphericalTensor>& eqn,
    const label fieldi
)
{
    addSupType(eqn, fieldi);
}


void Foam::fv::semiImplicitSource::addSup
(
    fvMatrix<tensor>& eqn,
    const label fieldi
)
{
    addSupType(eqn, fieldi);
}


void Foam::fv::semiImplicitSource::addSup
(
    const volScalarField& rho,
    fvMatrix<scalar>& eqn,
    const label fieldi
)
{
    addSupType(eqn, fieldi);
}


void Foam::fv::semiImplicitSource::addSup
(
    const volScalarField& rho,
    fvMatrix<vector>& eqn,
    const label fieldi
)
{
    addSupType(eqn, fieldi);
}


void Foam::fv::semiImplicitSource::addSup
(
    const volScalarField& rho,
    fvMatrix<symmTensor>& eqn,
    const label fieldi
)
{
    addSupType(eqn, fieldi);
}


void Foam::fv::semiImplicitSource::addSup
(
    const volScalarField& rho,
    fvMatrix<sphericalTensor>& eqn,
    const label fieldi
)
{
    addSupType(eqn, fieldi);
}


void Foam::fv::semiImplicitSource::addSup
(
    const volScalarField& rho,
    fvMatrix<tensor>& eqn,
    const label fieldi
)
{
    addSupType(eqn, fieldi);
}


void Foam::fv::semiImplicitSource::addSup
(
    const volScalarField& alpha,
    const volScalarField& rho,
    fvMatrix<scalar>& eqn,
    const label fieldi
)
{
    addSupType(eqn, fieldi);
}


void Foam::fv::semiImplicitSource::addSup
(
    const volScalarField& alpha,
    const volScalarField& rho,
    fvMatrix<vector>& eqn,
    const label fieldi
)
{
    addSupType(eqn, fieldi);
}


void Foam::fv::semiImplicitSource::addSup
(
    const volScalarField& alpha,
    const volScalarField& rho,
    fvMatrix<symmTensor>& eqn,
    const label fieldi
)
{
    addSupType(eqn, fieldi);
}


void Foam::fv::semiImplicitSource::addSup
(
    const volScalarField& alpha,
    const volScalarField& rho,
    fvMatrix<sphericalTensor>& eqn,
    const label fieldi
)
{
    addSupType(eqn, fieldi);
}


void Foam::fv::semiImplicitSource::addSup
(
    const volScalarField& alpha,
    const volScalarField& rho,
    fvMatrix<tensor>& eqn,
    const label fieldi
)
{
    addSupType(eqn, fieldi);
}


bool Foam::fv::semiImplicitSource::read(const dictionary& dict)
{
    if (cellSetOption::read(dict))
    {
        volumeMode_ = volumeModeNames_.read(coeffs_.lookup("volumeMode"));

        const dictionary& sources = coeffs_.subDict("sources");

        // Number of fields with a source term
        const label nFields = sources.size();

        // Set field names and source terms
        fieldNames_.setSize(nFields);
        fieldSp_.setSize(nFields);
        fieldSu_.setSize(nFields);
        label i = 0;
        forAllConstIter(dictionary, sources, iter)
        {
            fieldNames_[i] = iter().keyword();
            fieldSu_.set
            (
                i,
                objectFunction1::New<VolField>
                (
                    "explicit",
                    iter().dict(),
                    fieldNames_[i],
                    mesh_
                ).ptr()
            );
            fieldSp_.set
            (
                i,
                Function1<scalar>::New
                (
                    "implicit",
                    iter().dict()
                ).ptr()
            );
            i++;
        }

        // Set volume normalisation
        if (volumeMode_ == volumeMode::absolute)
        {
            VDash_ = V_;
        }

        applied_.setSize(nFields, false);

        return true;
    }
    else
    {
        return false;
    }
}

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