Datasets:

introvoyz042
/

OpenFOAM-dev

License:

Dataset card Files Files and versions

xet

Community

OpenFOAM-dev / data /src /lagrangian /parcel /fvModels /clouds /clouds.C

introvoyz042

Migrated from GitHub

5a600cf verified about 1 month ago

Raw History Blame Contribute Delete

9.2 kB

/*---------------------------------------------------------------------------*\
  =========                 |
  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   \\    /   O peration     | Website:  https://openfoam.org
    \\  /    A nd           | Copyright (C) 2021-2026 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 "clouds.H"
#include "multicomponentThermo.H"
#include "fvMatrix.H"
#include "addToRunTimeSelectionTable.H"

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

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

        addToRunTimeSelectionTable
        (
            fvModel,
            clouds,
            dictionary
        );
    }
}


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

Foam::fv::clouds::clouds
(
    const word& sourceName,
    const word& modelType,
    const fvMesh& mesh,
    const dictionary& dict
)
:
    fvModel(sourceName, modelType, mesh, dict),
    g_
    (
        IOobject
        (
            "g",
            mesh.time().constant(),
            mesh,
            IOobject::READ_IF_PRESENT,
            IOobject::NO_WRITE
        ),
        dimensionedVector(dimensions::acceleration, Zero)
    ),
    carrierHasThermo_
    (
        mesh.foundObject<fluidThermo>(physicalProperties::typeName)
    ),
    tCarrierThermo_
    (
        carrierHasThermo_
      ? tmpNrc<fluidThermo>
        (
            mesh.lookupObject<fluidThermo>(physicalProperties::typeName)
        )
      : tmpNrc<fluidThermo>(nullptr)
    ),
    tCarrierViscosity_
    (
        carrierHasThermo_
      ? tmpNrc<viscosityModel>(nullptr)
      : tmpNrc<viscosityModel>
        (
            mesh.lookupObject<viscosityModel>(physicalProperties::typeName)
        )
    ),
    tRho_
    (
        carrierHasThermo_
      ? tmp<volScalarField>(nullptr)
      : tmp<volScalarField>
        (
            new volScalarField
            (
                IOobject
                (
                    "rho",
                    mesh.time().name(),
                    mesh
                ),
                mesh,
                dimensionedScalar
                (
                    "rho",
                    dimensions::density,
                    tCarrierViscosity_()
                )
            )
        )
    ),
    tMu_
    (
        carrierHasThermo_
      ? tmp<volScalarField>(nullptr)
      : tmp<volScalarField>
        (
            new volScalarField("mu", tRho_()*tCarrierViscosity_().nu())
        )
    ),
    cloudNames_
    (
        dict.lookupOrDefault<wordList>
        (
            "clouds",
            parcelCloudList::defaultCloudNames
        )
    ),
    rhoName_(dict.lookupOrDefault<word>("rho", "rho")),
    UName_(dict.lookupOrDefault<word>("U", "U")),
    cloudsPtr_
    (
        carrierHasThermo_
      ? new parcelCloudList
        (
            cloudNames_,
            mesh.lookupObject<volScalarField>(rhoName_),
            mesh.lookupObject<volVectorField>(UName_),
            g_,
            tCarrierThermo_()
        )
      : new parcelCloudList
        (
            cloudNames_,
            tRho_(),
            mesh.lookupObject<volVectorField>(UName_),
            tMu_(),
            g_
        )
    ),
    curTimeIndex_(-1)
{}


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

Foam::wordList Foam::fv::clouds::addSupFields() const
{
    if (!cloudsPtr_->coupled())
    {
        return wordList();
    }

    wordList fieldNames(1, UName_);

    if (carrierHasThermo_)
    {
        const fluidThermo& carrierThermo = tCarrierThermo_();

        fieldNames.append(rhoName_);

        fieldNames.append(carrierThermo.he().name());

        if (isA<multicomponentThermo>(carrierThermo))
        {
            const multicomponentThermo& carrierMcThermo =
                refCast<const multicomponentThermo>(carrierThermo);

            forAll(carrierMcThermo.Y(), i)
            {
                if (carrierMcThermo.solveSpecie(i))
                {
                    fieldNames.append(carrierMcThermo.Y()[i].name());
                }
            }
        }
    }

    return fieldNames;
}


void Foam::fv::clouds::correct()
{
    if (curTimeIndex_ == mesh().time().timeIndex())
    {
        return;
    }

    if (!carrierHasThermo_)
    {
        tMu_.ref() = tRho_()*tCarrierViscosity_().nu();
    }

    cloudsPtr_().evolve();

    curTimeIndex_ = mesh().time().timeIndex();
}


void Foam::fv::clouds::addSup
(
    const volScalarField& rho,
    fvMatrix<scalar>& eqn
) const
{
    if (debug)
    {
        Info<< type() << ": applying source to " << eqn.psi().name() << endl;
    }

    if (!carrierHasThermo_)
    {
        FatalErrorInFunction
            << "Applying source to compressible equation when carrier thermo "
            << "is not available"
            << exit(FatalError);
    }

    if (rho.name() == rhoName_)
    {
        eqn += cloudsPtr_().Srho(eqn.psi());
    }
    else
    {
        FatalErrorInFunction
            << "Support for field " << rho.name() << " is not implemented"
            << exit(FatalError);
    }
}


void Foam::fv::clouds::addSup
(
    const volScalarField& rho,
    const volScalarField& field,
    fvMatrix<scalar>& eqn
) const
{
    if (debug)
    {
        Info<< type() << ": applying source to " << eqn.psi().name() << endl;
    }

    if (!carrierHasThermo_)
    {
        FatalErrorInFunction
            << "Applying source to compressible equation when carrier thermo "
            << "is not available"
            << exit(FatalError);
    }

    const fluidThermo& carrierThermo = tCarrierThermo_();

    if (&field == &carrierThermo.he())
    {
        eqn += cloudsPtr_().Sh(eqn.psi());
        return;
    }

    if (isA<multicomponentThermo>(carrierThermo))
    {
        const multicomponentThermo& carrierMcThermo =
            refCast<const multicomponentThermo>(carrierThermo);

        if (carrierMcThermo.containsSpecie(field.name()))
        {
            eqn +=
                cloudsPtr_().SYi
                (
                    carrierMcThermo.specieIndex(field),
                    field
                );
            return;
        }
    }

    {
        FatalErrorInFunction
            << "Support for field " << field.name() << " is not implemented"
            << exit(FatalError);
    }
}


void Foam::fv::clouds::addSup
(
    const volVectorField& U,
    fvMatrix<vector>& eqn
) const
{
    if (debug)
    {
        Info<< type() << ": applying source to " << eqn.psi().name() << endl;
    }

    if (carrierHasThermo_)
    {
        FatalErrorInFunction
            << "Applying source to incompressible equation when carrier thermo "
            << "is available"
            << exit(FatalError);
    }

    if (U.name() == UName_)
    {
        eqn += cloudsPtr_().SU(eqn.psi())/tRho_();
    }
    else
    {
        FatalErrorInFunction
            << "Support for field " << U.name() << " is not implemented"
            << exit(FatalError);
    }
}


void Foam::fv::clouds::addSup
(
    const volScalarField& rho,
    const volVectorField& U,
    fvMatrix<vector>& eqn
) const
{
    if (debug)
    {
        Info<< type() << ": applying source to " << eqn.psi().name() << endl;
    }

    if (!carrierHasThermo_)
    {
        FatalErrorInFunction
            << "Applying source to compressible equation when carrier thermo "
            << "is not available"
            << exit(FatalError);
    }

    if (U.name() == UName_)
    {
        eqn += cloudsPtr_().SU(eqn.psi());
    }
    else
    {
        FatalErrorInFunction
            << "Support for field " << U.name() << " is not implemented"
            << exit(FatalError);
    }
}


void Foam::fv::clouds::preUpdateMesh()
{
    // Store the particle positions
    cloudsPtr_().storeGlobalPositions();
}


void Foam::fv::clouds::topoChange(const polyTopoChangeMap& map)
{
    cloudsPtr_().topoChange(map);
}


void Foam::fv::clouds::mapMesh(const polyMeshMap& map)
{
    cloudsPtr_().mapMesh(map);
}


void Foam::fv::clouds::distribute(const polyDistributionMap& map)
{
    cloudsPtr_().distribute(map);
}


bool Foam::fv::clouds::movePoints()
{
    return true;
}


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

	/---------------------------------------------------------------------------\
	========= \|
	\\ / F ield \| OpenFOAM: The Open Source CFD Toolbox
	\\ / O peration \| Website: https://openfoam.org
	\\ / A nd \| Copyright (C) 2021-2026 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 "clouds.H"
	#include "multicomponentThermo.H"
	#include "fvMatrix.H"
	#include "addToRunTimeSelectionTable.H"

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

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

	addToRunTimeSelectionTable
	(
	fvModel,
	clouds,
	dictionary
	);
	}
	}


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

	Foam::fv::clouds::clouds
	(
	const word& sourceName,
	const word& modelType,
	const fvMesh& mesh,
	const dictionary& dict
	)
	:
	fvModel(sourceName, modelType, mesh, dict),
	g_
	(
	IOobject
	(
	"g",
	mesh.time().constant(),
	mesh,
	IOobject::READ_IF_PRESENT,
	IOobject::NO_WRITE
	),
	dimensionedVector(dimensions::acceleration, Zero)
	),
	carrierHasThermo_
	(
	mesh.foundObject<fluidThermo>(physicalProperties::typeName)
	),
	tCarrierThermo_
	(
	carrierHasThermo_
	? tmpNrc<fluidThermo>
	(
	mesh.lookupObject<fluidThermo>(physicalProperties::typeName)
	)
	: tmpNrc<fluidThermo>(nullptr)
	),
	tCarrierViscosity_
	(
	carrierHasThermo_
	? tmpNrc<viscosityModel>(nullptr)
	: tmpNrc<viscosityModel>
	(
	mesh.lookupObject<viscosityModel>(physicalProperties::typeName)
	)
	),
	tRho_
	(
	carrierHasThermo_
	? tmp<volScalarField>(nullptr)
	: tmp<volScalarField>
	(
	new volScalarField
	(
	IOobject
	(
	"rho",
	mesh.time().name(),
	mesh
	),
	mesh,
	dimensionedScalar
	(
	"rho",
	dimensions::density,
	tCarrierViscosity_()
	)
	)
	)
	),
	tMu_
	(
	carrierHasThermo_
	? tmp<volScalarField>(nullptr)
	: tmp<volScalarField>
	(
	new volScalarField("mu", tRho_()*tCarrierViscosity_().nu())
	)
	),
	cloudNames_
	(
	dict.lookupOrDefault<wordList>
	(
	"clouds",
	parcelCloudList::defaultCloudNames
	)
	),
	rhoName_(dict.lookupOrDefault<word>("rho", "rho")),
	UName_(dict.lookupOrDefault<word>("U", "U")),
	cloudsPtr_
	(
	carrierHasThermo_
	? new parcelCloudList
	(
	cloudNames_,
	mesh.lookupObject<volScalarField>(rhoName_),
	mesh.lookupObject<volVectorField>(UName_),
	g_,
	tCarrierThermo_()
	)
	: new parcelCloudList
	(
	cloudNames_,
	tRho_(),
	mesh.lookupObject<volVectorField>(UName_),
	tMu_(),
	g_
	)
	),
	curTimeIndex_(-1)
	{}


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

	Foam::wordList Foam::fv::clouds::addSupFields() const
	{
	if (!cloudsPtr_->coupled())
	{
	return wordList();
	}

	wordList fieldNames(1, UName_);

	if (carrierHasThermo_)
	{
	const fluidThermo& carrierThermo = tCarrierThermo_();

	fieldNames.append(rhoName_);

	fieldNames.append(carrierThermo.he().name());

	if (isA<multicomponentThermo>(carrierThermo))
	{
	const multicomponentThermo& carrierMcThermo =
	refCast<const multicomponentThermo>(carrierThermo);

	forAll(carrierMcThermo.Y(), i)
	{
	if (carrierMcThermo.solveSpecie(i))
	{
	fieldNames.append(carrierMcThermo.Y()[i].name());
	}
	}
	}
	}

	return fieldNames;
	}


	void Foam::fv::clouds::correct()
	{
	if (curTimeIndex_ == mesh().time().timeIndex())
	{
	return;
	}

	if (!carrierHasThermo_)
	{
	tMu_.ref() = tRho_()*tCarrierViscosity_().nu();
	}

	cloudsPtr_().evolve();

	curTimeIndex_ = mesh().time().timeIndex();
	}


	void Foam::fv::clouds::addSup
	(
	const volScalarField& rho,
	fvMatrix<scalar>& eqn
	) const
	{
	if (debug)
	{
	Info<< type() << ": applying source to " << eqn.psi().name() << endl;
	}

	if (!carrierHasThermo_)
	{
	FatalErrorInFunction
	<< "Applying source to compressible equation when carrier thermo "
	<< "is not available"
	<< exit(FatalError);
	}

	if (rho.name() == rhoName_)
	{
	eqn += cloudsPtr_().Srho(eqn.psi());
	}
	else
	{
	FatalErrorInFunction
	<< "Support for field " << rho.name() << " is not implemented"
	<< exit(FatalError);
	}
	}


	void Foam::fv::clouds::addSup
	(
	const volScalarField& rho,
	const volScalarField& field,
	fvMatrix<scalar>& eqn
	) const
	{
	if (debug)
	{
	Info<< type() << ": applying source to " << eqn.psi().name() << endl;
	}

	if (!carrierHasThermo_)
	{
	FatalErrorInFunction
	<< "Applying source to compressible equation when carrier thermo "
	<< "is not available"
	<< exit(FatalError);
	}

	const fluidThermo& carrierThermo = tCarrierThermo_();

	if (&field == &carrierThermo.he())
	{
	eqn += cloudsPtr_().Sh(eqn.psi());
	return;
	}

	if (isA<multicomponentThermo>(carrierThermo))
	{
	const multicomponentThermo& carrierMcThermo =
	refCast<const multicomponentThermo>(carrierThermo);

	if (carrierMcThermo.containsSpecie(field.name()))
	{
	eqn +=
	cloudsPtr_().SYi
	(
	carrierMcThermo.specieIndex(field),
	field
	);
	return;
	}
	}

	{
	FatalErrorInFunction
	<< "Support for field " << field.name() << " is not implemented"
	<< exit(FatalError);
	}
	}


	void Foam::fv::clouds::addSup
	(
	const volVectorField& U,
	fvMatrix<vector>& eqn
	) const
	{
	if (debug)
	{
	Info<< type() << ": applying source to " << eqn.psi().name() << endl;
	}

	if (carrierHasThermo_)
	{
	FatalErrorInFunction
	<< "Applying source to incompressible equation when carrier thermo "
	<< "is available"
	<< exit(FatalError);
	}

	if (U.name() == UName_)
	{
	eqn += cloudsPtr_().SU(eqn.psi())/tRho_();
	}
	else
	{
	FatalErrorInFunction
	<< "Support for field " << U.name() << " is not implemented"
	<< exit(FatalError);
	}
	}


	void Foam::fv::clouds::addSup
	(
	const volScalarField& rho,
	const volVectorField& U,
	fvMatrix<vector>& eqn
	) const
	{
	if (debug)
	{
	Info<< type() << ": applying source to " << eqn.psi().name() << endl;
	}

	if (!carrierHasThermo_)
	{
	FatalErrorInFunction
	<< "Applying source to compressible equation when carrier thermo "
	<< "is not available"
	<< exit(FatalError);
	}

	if (U.name() == UName_)
	{
	eqn += cloudsPtr_().SU(eqn.psi());
	}
	else
	{
	FatalErrorInFunction
	<< "Support for field " << U.name() << " is not implemented"
	<< exit(FatalError);
	}
	}


	void Foam::fv::clouds::preUpdateMesh()
	{
	// Store the particle positions
	cloudsPtr_().storeGlobalPositions();
	}


	void Foam::fv::clouds::topoChange(const polyTopoChangeMap& map)
	{
	cloudsPtr_().topoChange(map);
	}


	void Foam::fv::clouds::mapMesh(const polyMeshMap& map)
	{
	cloudsPtr_().mapMesh(map);
	}


	void Foam::fv::clouds::distribute(const polyDistributionMap& map)
	{
	cloudsPtr_().distribute(map);
	}


	bool Foam::fv::clouds::movePoints()
	{
	return true;
	}


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