Program Listing for File KnownWallShearStressWallModelFvPatchScalarField.C

↰ Return to documentation for file (wallModels/KnownWallShearStressWallModelFvPatchScalarField.C)

/*---------------------------------------------------------------------------* \
License
    This file is part of libWallModelledLES.

    libWallModelledLES 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.

    libWallModelledLES 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 libWallModelledLES.
    If not, see <http://www.gnu.org/licenses/>.

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

#include "KnownWallShearStressWallModelFvPatchScalarField.H"
#include "fvPatchFieldMapper.H"
#include "volFields.H"
#include "addToRunTimeSelectionTable.H"
#include "dictionary.H"
#include "codeRules.H"
#include "scalarListIOList.H"
#include "SingleCellSampler.H"
#include "helpers.H"

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

void Foam::KnownWallShearStressWallModelFvPatchScalarField::writeLocalEntries(Ostream& os) const
{
    wallModelFvPatchScalarField::writeLocalEntries(os);
    sampler_->write(os);
}


Foam::tmp<Foam::scalarField>
Foam::KnownWallShearStressWallModelFvPatchScalarField::calcNut() const
{
    if (debug)
    {
        Info<< "Updating nut for patch " << patch().name() << nl;
    }


    const label patchi = patch().index();

    tmp<scalarField> nuw = this->nu(patchi);

    const scalarListIOList & wallGradU =
        sampler_->db().lookupObject<scalarListIOList>("wallGradU");

    scalarField magGradU(Helpers::mag(wallGradU));

    const volScalarField& tauWallField = db().lookupObject<volScalarField>("tauWall");
    const fvPatchScalarField & tauWall = tauWallField.boundaryField()[patchi];

    volScalarField & uTauField =
        const_cast<volScalarField &>
        (
            db().lookupObject<volScalarField>("uTauPredicted")
        );

    uTauField.boundaryFieldRef()[patchi] == sqrt(max(tauWall, scalar(0)));

    return max
    (
        scalar(0),
        tauWall/(magGradU + ROOTVSMALL) - nuw
    );
}


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

Foam::KnownWallShearStressWallModelFvPatchScalarField::
KnownWallShearStressWallModelFvPatchScalarField
(
    const fvPatch& p,
    const DimensionedField<scalar, volMesh>& iF
)
:
    wallModelFvPatchScalarField(p, iF),
    sampler_(nullptr)
{

    if (debug)
    {
        Info<< "Constructing KnownWallShearStressWallModelfvPatchScalarField"
            << "from copy and DimensionedField for patch " << patch().name()
            << nl;
    }

}

Foam::KnownWallShearStressWallModelFvPatchScalarField::
KnownWallShearStressWallModelFvPatchScalarField
(
    const KnownWallShearStressWallModelFvPatchScalarField& orig,
    const fvPatch& p,
    const DimensionedField<scalar, volMesh>& iF,
    const fvPatchFieldMapper& mapper
)
:
    wallModelFvPatchScalarField(orig, p, iF, mapper),
    sampler_(new SingleCellSampler(orig.sampler()))
{

    if (debug)
    {
        Info<< "Constructing KnownWallShearStressWallModelfvPatchScalarField"
            << "from copy and DimensionedField for patch " << patch().name()
            << nl;
    }
}


Foam::KnownWallShearStressWallModelFvPatchScalarField::
KnownWallShearStressWallModelFvPatchScalarField
(
    const fvPatch& p,
    const DimensionedField<scalar, volMesh>& iF,
    const dictionary& dict
)
:
    wallModelFvPatchScalarField(p, iF, dict),
    sampler_
    (
        new SingleCellSampler
        (
            p,
            averagingTime(),
            dict.lookupOrDefault<word>("interpolationType", "cell"),
            dict.lookupOrDefault<word>("sampler", "Tree"),
            dict.lookupOrDefault<word>
            (
                "lengthScale",
                dict.lookupOrDefault<word>("lengthScaleType", "CubeRootVol")
            ),
            dict.lookupOrDefault<bool>("hIsIndex", false)
        )
    )
{
    if (debug)
    {
        Info<< "Constructing KnownWallShearStressWallModelfvPatchScalarField"
            << "from copy and DimensionedField for patch " << patch().name()
            << nl;
    }

    if (!db().foundObject<volScalarField>("tauWall"))
    {
        if (db().found("tauWall"))
        {
            FatalErrorInFunction
                << "Object tauWall is registered, but is not a volScalarField"
                << nl << abort(FatalError);
        }

        db().store
        (
            new volScalarField
            (
                IOobject
                (
                    "tauWall",
                    db().time().timeName(),
                    db(),
                    IOobject::MUST_READ,
                    IOobject::AUTO_WRITE
                ),
                patch().boundaryMesh().mesh()
            )
        );
    }


    label patchI = patch().index();

    const volScalarField& tauWall = db().lookupObject<volScalarField>("tauWall");

    volScalarField & uTauField =
    const_cast<volScalarField &>
    (
        db().lookupObject<volScalarField>("uTauPredicted")
    );

    uTauField.boundaryFieldRef()[patchI] ==
        sqrt(max(tauWall.boundaryField()[patchI], scalar(0)));
}


Foam::KnownWallShearStressWallModelFvPatchScalarField::
KnownWallShearStressWallModelFvPatchScalarField
(
    const KnownWallShearStressWallModelFvPatchScalarField& orig
)
:
    wallModelFvPatchScalarField(orig),
    sampler_(new SingleCellSampler(orig.sampler_()))
{

    if (debug)
    {
        Info<< "Constructing KnownWallShearStressWallModelfvPatchScalarField"
            << "from copy and DimensionedField for patch " << patch().name()
            << nl;
    }
}


Foam::KnownWallShearStressWallModelFvPatchScalarField::
KnownWallShearStressWallModelFvPatchScalarField
(
    const KnownWallShearStressWallModelFvPatchScalarField& orig,
    const DimensionedField<scalar, volMesh>& iF
)
:
    wallModelFvPatchScalarField(orig, iF),
    sampler_(new SingleCellSampler(orig.sampler_()))
{

    if (debug)
    {
        Info<< "Constructing KnownWallShearStressWallModelfvPatchScalarField"
            << "from copy and DimensionedField for patch " << patch().name()
            << nl;
    }
}


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

void Foam::KnownWallShearStressWallModelFvPatchScalarField::write(Ostream& os) const
{
    wallModelFvPatchScalarField::write(os);
}


void Foam::KnownWallShearStressWallModelFvPatchScalarField::updateCoeffs()
{
    if (updated())
    {
        return;
    }

    sampler().recomputeFields();
    sampler().sample();

    wallModelFvPatchScalarField::updateCoeffs();
}

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

#if !defined(DOXYGEN_SHOULD_SKIP_THIS)
namespace Foam
{
    makePatchTypeField
    (
        fvPatchScalarField,
        KnownWallShearStressWallModelFvPatchScalarField
    );
}
#endif

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