/*---------------------------------------------------------------------------*\
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2011-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 .
\*---------------------------------------------------------------------------*/
#include "DimensionedField.H"
#include "dimensionedType.H"
#include "Time.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
{
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#define checkFieldAssignment(df1, df2) \
\
if \
( \
static_cast(&df1) \
== static_cast(&df2) \
) \
{ \
FatalErrorInFunction \
<< "attempted assignment to self for field " \
<< (df1).name() << abort(FatalError); \
}
#define checkFieldOperation(df1, df2, op) \
\
if (&(df1).mesh() != &(df2).mesh()) \
{ \
FatalErrorInFunction \
<< "different mesh for fields " \
<< (df1).name() << " and " << (df2).name() \
<< " during operation " << op \
<< abort(FatalError); \
}
// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
template class PrimitiveField>
DimensionedField::DimensionedField
(
const IOobject& io,
const GeoMesh& mesh,
const dimensionSet& dims,
const PrimitiveField& field
)
:
regIOobject(io),
PrimitiveField(field),
OldTimeField(this->time().timeIndex()),
mesh_(mesh),
dimensions_(dims)
{
if (field.size() && field.size() != mesh.size())
{
FatalErrorInFunction
<< "size of field = " << field.size()
<< " is not the same as the size of mesh = "
<< mesh.size()
<< abort(FatalError);
}
}
template class PrimitiveField>
DimensionedField::DimensionedField
(
const IOobject& io,
const GeoMesh& mesh,
const dimensionSet& dims,
const tmp>& tfield
)
:
regIOobject(io),
PrimitiveField(tfield),
OldTimeField(this->time().timeIndex()),
mesh_(mesh),
dimensions_(dims)
{
if (this->size() && this->size() != mesh.size())
{
FatalErrorInFunction
<< "size of field = " << this->size()
<< " is not the same as the size of mesh = "
<< mesh.size()
<< abort(FatalError);
}
}
template class PrimitiveField>
template
DimensionedField::DimensionedField
(
const IOobject& io,
const GeoMesh& mesh,
const dimensionSet& dims,
const Expression& e
)
:
regIOobject(io),
PrimitiveField(e),
OldTimeField(this->time().timeIndex()),
mesh_(mesh),
dimensions_(dims)
{
if (this->size() && this->size() != mesh.size())
{
FatalErrorInFunction
<< "size of field = " << this->size()
<< " is not the same as the size of mesh = "
<< mesh.size()
<< abort(FatalError);
}
}
template class PrimitiveField>
DimensionedField::DimensionedField
(
const IOobject& io,
const GeoMesh& mesh,
const dimensionSet& dims,
const bool checkIOFlags
)
:
regIOobject(io),
PrimitiveField(mesh.size()),
OldTimeField(this->time().timeIndex()),
mesh_(mesh),
dimensions_(dims)
{
// Expand dynamic primitive fields to their full size
PrimitiveField::setSize(mesh.size());
if (checkIOFlags)
{
readIfPresent();
}
}
template class PrimitiveField>
DimensionedField::DimensionedField
(
const IOobject& io,
const GeoMesh& mesh,
const dimensioned& dt,
const bool checkIOFlags
)
:
regIOobject(io),
PrimitiveField(mesh.size(), dt.value()),
OldTimeField(this->time().timeIndex()),
mesh_(mesh),
dimensions_(dt.dimensions())
{
if (checkIOFlags)
{
readIfPresent();
}
}
template class PrimitiveField>
DimensionedField::DimensionedField
(
const DimensionedField& df
)
:
regIOobject(df),
PrimitiveField(df.primitiveField()),
OldTimeField(df),
mesh_(df.mesh_),
dimensions_(df.dimensions_)
{}
template class PrimitiveField>
DimensionedField::DimensionedField
(
DimensionedField&& df
)
:
regIOobject(move(df)),
PrimitiveField(move(df.primitiveFieldRef())),
OldTimeField(move(df)),
mesh_(df.mesh_),
dimensions_(move(df.dimensions_))
{}
template class PrimitiveField>
template class PrimitiveField2>
DimensionedField::DimensionedField
(
const DimensionedField& df
)
:
regIOobject(df),
PrimitiveField(df.primitiveField()),
OldTimeField(this->time().timeIndex()),
mesh_(df.mesh()),
dimensions_(df.dimensions())
{}
template class PrimitiveField>
template class PrimitiveField2>
DimensionedField::DimensionedField
(
DimensionedField& df,
const bool reuse
)
:
regIOobject(df, reuse),
PrimitiveField(df.primitiveFieldRef(), reuse),
OldTimeField(this->time().timeIndex()),
mesh_(df.mesh()),
dimensions_(df.dimensions())
{}
template class PrimitiveField>
DimensionedField::DimensionedField
(
const tmp>& tdf
)
:
regIOobject(tdf(), tdf.isTmp()),
PrimitiveField
(
const_cast&>(tdf()),
tdf.isTmp()
),
OldTimeField(this->time().timeIndex()),
mesh_(tdf().mesh_),
dimensions_(tdf().dimensions_)
{
tdf.clear();
}
template class PrimitiveField>
template class PrimitiveField2>
DimensionedField::DimensionedField
(
const IOobject& io,
const DimensionedField& df,
const bool checkIOFlags
)
:
regIOobject(io),
PrimitiveField(df.primitiveField()),
OldTimeField(this->time().timeIndex()),
mesh_(df.mesh_),
dimensions_(df.dimensions_)
{
if (!checkIOFlags || !readIfPresent())
{
copyOldTimes(io, df);
}
}
template class PrimitiveField>
template class PrimitiveField2>
DimensionedField::DimensionedField
(
const IOobject& io,
DimensionedField& df,
const bool reuse,
const bool checkIOFlags
)
:
regIOobject(io),
PrimitiveField(df, reuse),
OldTimeField(this->time().timeIndex()),
mesh_(df.mesh_),
dimensions_(df.dimensions_)
{
if (checkIOFlags)
{
readIfPresent();
}
}
template class PrimitiveField>
DimensionedField::DimensionedField
(
const IOobject& io,
const tmp>& tdf,
const bool checkIOFlags
)
:
regIOobject(io),
PrimitiveField
(
const_cast&>(tdf()),
tdf.isTmp()
),
OldTimeField(this->time().timeIndex()),
mesh_(tdf().mesh_),
dimensions_(tdf().dimensions_)
{
tdf.clear();
if (checkIOFlags)
{
readIfPresent();
}
}
template class PrimitiveField>
template
DimensionedField::DimensionedField
(
const IOobject& io,
const Expression& e,
const bool checkIOFlags
)
:
regIOobject(io),
PrimitiveField
(
expression::access
(
e,
expression::Value(),
expression::Base()
)
),
OldTimeField(this->time().timeIndex()),
mesh_(expression::getFirst>(e)),
dimensions_(expression::access(e, dimensions::invalid))
{
expression::assertSameAllContainerProperty
<
expression::MeshPointer
>(e);
if (checkIOFlags)
{
readIfPresent();
}
}
template class PrimitiveField>
template class PrimitiveField2>
DimensionedField::DimensionedField
(
const word& newName,
const DimensionedField& df
)
:
regIOobject(newName, df, newName != df.name()),
PrimitiveField(df.primitiveField()),
OldTimeField(this->time().timeIndex()),
mesh_(df.mesh_),
dimensions_(df.dimensions_)
{
copyOldTimes(newName, df);
}
template class PrimitiveField>
template class PrimitiveField2>
DimensionedField::DimensionedField
(
const word& newName,
DimensionedField& df,
const bool reuse
)
:
regIOobject(newName, df, true),
PrimitiveField(df, reuse),
OldTimeField(this->time().timeIndex()),
mesh_(df.mesh_),
dimensions_(df.dimensions_)
{}
template class PrimitiveField>
DimensionedField::DimensionedField
(
const word& newName,
const tmp>& tdf
)
:
regIOobject(newName, tdf(), true),
PrimitiveField
(
const_cast&>(tdf()),
tdf.isTmp()
),
OldTimeField(this->time().timeIndex()),
mesh_(tdf().mesh_),
dimensions_(tdf().dimensions_)
{
tdf.clear();
}
template class PrimitiveField>
template
DimensionedField::DimensionedField
(
const Expression& e
)
:
regIOobject
(
expression::name(e),
expression::getFirst(e),
false // <-- do not register as not explicitly named
),
PrimitiveField
(
expression::access
(
e,
expression::Value(),
expression::Base()
)
),
OldTimeField(this->time().timeIndex()),
mesh_(expression::getFirst>(e)),
dimensions_(expression::access(e, dimensions::invalid))
{
expression::assertSameAllContainerProperty
<
expression::MeshPointer
>(e);
}
template class PrimitiveField>
tmp>
DimensionedField::clone() const
{
return tmp>
(
new DimensionedField(*this)
);
}
template class PrimitiveField>
Foam::tmp>
DimensionedField::New
(
const word& name,
const GeoMesh& mesh,
const dimensionSet& ds,
const PrimitiveField& field
)
{
const bool cacheTmp = mesh.db().temporaryObjectCached(name);
return tmp>
(
new DimensionedField
(
IOobject
(
name,
mesh.db().time().name(),
mesh.db(),
IOobject::NO_READ,
IOobject::NO_WRITE,
cacheTmp
),
mesh,
ds,
field
),
cacheTmp
);
}
template class PrimitiveField>
Foam::tmp>
DimensionedField::New
(
const word& name,
const GeoMesh& mesh,
const dimensionSet& ds,
const tmp>& tfield
)
{
const bool cacheTmp = mesh.db().temporaryObjectCached(name);
return tmp>
(
new DimensionedField
(
IOobject
(
name,
mesh.db().time().name(),
mesh.db(),
IOobject::NO_READ,
IOobject::NO_WRITE,
cacheTmp
),
mesh,
ds,
tfield
),
cacheTmp
);
}
template class PrimitiveField>
template
Foam::tmp>
DimensionedField::New
(
const word& name,
const GeoMesh& mesh,
const dimensionSet& ds,
const Expression& e
)
{
return New(name, mesh, ds, eval(e));
}
template class PrimitiveField>
Foam::tmp>
DimensionedField::New
(
const word& name,
const GeoMesh& mesh,
const dimensionSet& ds
)
{
const bool cacheTmp = mesh.db().temporaryObjectCached(name);
return tmp>
(
new DimensionedField
(
IOobject
(
name,
mesh.db().time().name(),
mesh.db(),
IOobject::NO_READ,
IOobject::NO_WRITE,
cacheTmp
),
mesh,
ds,
false
),
cacheTmp
);
}
template class PrimitiveField>
Foam::tmp>
DimensionedField::New
(
const word& name,
const GeoMesh& mesh,
const dimensioned& dt
)
{
const bool cacheTmp = mesh.db().temporaryObjectCached(name);
return tmp>
(
new DimensionedField
(
IOobject
(
name,
mesh.db().time().name(),
mesh.db(),
IOobject::NO_READ,
IOobject::NO_WRITE,
cacheTmp
),
mesh,
dt,
false
),
cacheTmp
);
}
template class PrimitiveField>
template class PrimitiveField2>
Foam::tmp>
DimensionedField::New
(
const word& newName,
const DimensionedField& df
)
{
const bool cacheTmp = df.db().temporaryObjectCached(newName);
return tmp>
(
new DimensionedField
(
IOobject
(
newName,
df.instance(),
df.local(),
df.db(),
IOobject::NO_READ,
IOobject::NO_WRITE,
cacheTmp
),
df
),
cacheTmp
);
}
template class PrimitiveField>
Foam::tmp>
DimensionedField::New
(
const word& newName,
const tmp>& tdf
)
{
const bool cacheTmp = tdf().db().temporaryObjectCached(newName);
return tmp>
(
new DimensionedField
(
IOobject
(
newName,
tdf().instance(),
tdf().local(),
tdf().db(),
IOobject::NO_READ,
IOobject::NO_WRITE,
cacheTmp
),
tdf
),
cacheTmp
);
}
// * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //
template class PrimitiveField>
DimensionedField::~DimensionedField()
{
db().cacheTemporaryObject(*this);
}
// * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
template class PrimitiveField>
PrimitiveField&
Foam::DimensionedField::primitiveFieldRef()
{
this->setUpToDate();
storeOldTimes();
return *this;
}
template class PrimitiveField>
template class PrimitiveField2>
void DimensionedField::replace
(
const direction d,
const DimensionedField
<
typename DimensionedField::cmptType,
GeoMesh,
PrimitiveField2
>& df
)
{
dimensions_ = df.dimensions();
PrimitiveField::replace(d, df.primitiveField());
}
template class PrimitiveField>
template class PrimitiveField2>
void DimensionedField::replace
(
const direction d,
const tmp
<
DimensionedField
<
typename DimensionedField::cmptType,
GeoMesh,
PrimitiveField2
>
>& tdf
)
{
dimensions_ = tdf().dimensions();
PrimitiveField::replace(d, tdf().primitiveField());
tdf.clear();
}
template class PrimitiveField>
template
void DimensionedField::replace
(
const direction d,
const Expression& e
)
{
expression::assertSameAllContainerProperty
<
expression::MeshPointer
>(e);
dimensions_ = expression::access(e, dimensions::invalid);
PrimitiveField::replace
(
d,
expression::access
(
e,
expression::Value(),
expression::Base()
)
);
}
template class PrimitiveField>
void DimensionedField::replace
(
const direction d,
const dimensioned& df
)
{
dimensions_ = df.dimensions();
PrimitiveField::replace(d, df.value());
}
template class PrimitiveField>
template class PrimitiveField2>
void DimensionedField::reset
(
const DimensionedField& df
)
{
checkFieldAssignment(*this, df);
dimensions_ = df.dimensions();
PrimitiveField::operator=(df.primitiveField());
}
template class PrimitiveField>
void DimensionedField::reset
(
const tmp>& tdf
)
{
const DimensionedField& df = tdf();
checkFieldAssignment(*this, df);
dimensions_ = df.dimensions();
if (tdf.isTmp())
{
transfer(tdf.ref());
}
else
{
PrimitiveField::operator=(df.primitiveField());
}
tdf.clear();
}
template class PrimitiveField>
template class PrimitiveField2>
void DimensionedField::reset
(
const tmp>& tdf
)
{
reset(tdf());
tdf.clear();
}
template class PrimitiveField>
void DimensionedField::boundLower
(
const dimensioned& lower
)
{
dimensions_ = lower.dimensions();
PrimitiveField::boundLower(lower.value());
}
template class PrimitiveField>
void DimensionedField::boundUpper
(
const dimensioned& upper
)
{
dimensions_ = upper.dimensions();
PrimitiveField::boundUpper(upper.value());
}
template class PrimitiveField>
void DimensionedField::bound
(
const dimensioned& lower,
const dimensioned& upper
)
{
dimensions_ = lower.dimensions();
dimensions_ = upper.dimensions();
PrimitiveField::bound(lower.value(), upper.value());
}
// * * * * * * * * * * * * * * * Member Operators * * * * * * * * * * * * * //
template class PrimitiveField>
void DimensionedField::operator=
(
const DimensionedField& df
)
{
checkFieldAssignment(*this, df);
checkFieldOperation(*this, df, "=");
dimensions_ = df.dimensions();
PrimitiveField::operator=(df.primitiveField());
}
template class PrimitiveField>
void DimensionedField::operator=
(
DimensionedField&& df
)
{
checkFieldAssignment(*this, df);
checkFieldOperation(*this, df, "=");
dimensions_ = move(df.dimensions());
PrimitiveField::operator=(move(df.primitiveFieldRef()));
}
template class PrimitiveField>
void DimensionedField::operator=
(
const tmp>& tdf
)
{
const DimensionedField& df = tdf();
checkFieldAssignment(*this, df);
checkFieldOperation(*this, df, "=");
dimensions_ = df.dimensions();
if (tdf.isTmp())
{
transfer(tdf.ref());
}
else
{
PrimitiveField::operator=(df.primitiveField());
}
tdf.clear();
}
template class PrimitiveField>
template class PrimitiveField2>
void DimensionedField::operator=
(
const DimensionedField& df
)
{
checkFieldOperation(*this, df, "=");
dimensions_ = df.dimensions();
PrimitiveField::operator=(df.primitiveField());
}
template class PrimitiveField>
template class PrimitiveField2>
void DimensionedField::operator=
(
const tmp>& tdf
)
{
const DimensionedField& df = tdf();
checkFieldOperation(*this, df, "=");
dimensions_ = df.dimensions();
PrimitiveField::operator=(df.primitiveField());
tdf.clear();
}
template class PrimitiveField>
template
void DimensionedField::operator=
(
const Expression& e
)
{
expression::assertSameAllContainerProperty
<
expression::MeshPointer
>(e);
dimensions_ = expression::access(e, dimensions::invalid);
primitiveFieldRef() =
expression::access
(
e,
expression::Value(),
expression::Base()
);
}
template class PrimitiveField>
void DimensionedField::operator=
(
const dimensioned& dt
)
{
dimensions_ = dt.dimensions();
PrimitiveField::operator=(dt.value());
}
template class PrimitiveField>
void DimensionedField::operator=(const zero&)
{
PrimitiveField::operator=(Zero);
}
#define COMPUTED_ASSIGNMENT(TYPE, op) \
\
template class PrimitiveField> \
template class PrimitiveField2> \
void DimensionedField::operator op \
( \
const DimensionedField& df \
) \
{ \
checkFieldOperation(*this, df, #op); \
\
dimensions_ op df.dimensions(); \
PrimitiveField::operator op(df.primitiveField()); \
} \
\
template class PrimitiveField> \
template class PrimitiveField2> \
void DimensionedField::operator op \
( \
const tmp>& tdf \
) \
{ \
operator op(tdf()); \
tdf.clear(); \
} \
\
template class PrimitiveField> \
void DimensionedField::operator op \
( \
const dimensioned& dt \
) \
{ \
dimensions_ op dt.dimensions(); \
PrimitiveField::operator op(dt.value()); \
} \
\
template class PrimitiveField> \
template \
void DimensionedField::operator op \
( \
const Expression& e \
) \
{ \
expression::assertSameAllContainerProperty \
< \
expression::MeshPointer \
>(e); \
\
dimensions_ op expression::access(e, dimensions::invalid); \
\
primitiveFieldRef() op \
expression::access \
( \
e, \
expression::Value(), \
expression::Base() \
); \
}
COMPUTED_ASSIGNMENT(Type, +=)
COMPUTED_ASSIGNMENT(Type, -=)
COMPUTED_ASSIGNMENT(scalar, *=)
COMPUTED_ASSIGNMENT(scalar, /=)
#undef COMPUTED_ASSIGNMENT
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#undef checkFieldAssignment
#undef checkFieldOperation
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
} // End namespace Foam
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#include "DimensionedFieldIO.C"
// ************************************************************************* //