This source is designed to model the effect of solidification and melting processes, e.g. windhield defrosting, within a specified region. The phase change occurs at the melting temperature, Tmelt. More...

#include <solidificationMeltingSource.H>

Inheritance diagram for solidificationMeltingSource:

[legend]

Collaboration diagram for solidificationMeltingSource:

[legend]

Public Types
enum	thermoMode { mdThermo , mdLookup }
	Options for the thermo mode specification. More...
Public Types inherited from cellSetOption
enum	selectionModeType : char { smAll , smCellSet , smCellZone , smPoints , smMovingPoints , smGeometric , smCellType }
	Enumeration for selection mode types. More...

Public Member Functions
	TypeName ("solidificationMeltingSource")
	Runtime type information.
	solidificationMeltingSource (const word &sourceName, const word &modelType, const dictionary &dict, const fvMesh &mesh)
	Construct from explicit source name and mesh.
	solidificationMeltingSource (const solidificationMeltingSource &)=delete
	No copy construct.
void	operator= (const solidificationMeltingSource &)=delete
	No copy assignment.
	~solidificationMeltingSource ()=default
	Destructor.
virtual void	addSup (fvMatrix< scalar > &eqn, const label fieldi)
	Add explicit contribution to enthalpy equation.
virtual void	addSup (fvMatrix< vector > &eqn, const label fieldi)
	Add implicit contribution to momentum equation.
virtual void	addSup (const volScalarField &rho, fvMatrix< scalar > &eqn, const label fieldi)
	Add explicit contribution to compressible enthalpy equation.
virtual void	addSup (const volScalarField &rho, fvMatrix< vector > &eqn, const label fieldi)
	Add implicit contribution to compressible momentum equation.
virtual bool	read (const dictionary &dict)
	Read source dictionary.
Public Member Functions inherited from cellSetOption
	TypeName ("cellSetOption")
	Runtime type information.
	cellSetOption (const word &name, const word &modelType, const dictionary &dict, const fvMesh &mesh)
	Construct from components.
virtual	~cellSetOption ()=default
	Destructor.
scalar	timeStart () const noexcept
	Return const access to the time start.
scalar	duration () const noexcept
	Return const access to the duration.
bool	inTimeLimits (const scalar timeValue) const
	True if within time limits.
bool	useSubMesh () const noexcept
	True if sub-selection should be used.
selectionModeType	selectionMode () const noexcept
	Return the cell selection mode.
const wordRes &	selectionNames () const noexcept
	Return const access to the selection names (set or zone selection).
const wordRe &	zoneName () const
	Return const access to the first set/zone name.
scalar	V () const noexcept
	Return const access to the total cell volume.
const labelList &	cells () const noexcept
	Return const access to the cell selection.
bool	isSelectionUpdated () const noexcept
	Return flag for selection updates.
scalar	timeStart (scalar val) noexcept
	Adjust the time start, return the old value.
scalar	duration (scalar val) noexcept
	Adjust the duration, return the old value.
virtual bool	isActive ()
	Is the source active?
const word &	cellSetName () const
	The name of the cell set/zone [as a word] for "cellSet" / "cellZone" selection modes).
Public Member Functions inherited from option
	TypeName ("option")
	Runtime type information.
	declareRunTimeSelectionTable (autoPtr, option, dictionary,(const word &name, const word &modelType, const dictionary &dict, const fvMesh &mesh),(name, modelType, dict, mesh))
	option (const word &name, const word &modelType, const dictionary &dict, const fvMesh &mesh)
	Construct from components.
autoPtr< option >	clone () const
	Return clone.
virtual	~option ()=default
	Destructor.
const word &	name () const noexcept
	Return const access to the source name.
const fvMesh &	mesh () const noexcept
	Return const access to the mesh database.
const dictionary &	coeffs () const noexcept
	Return dictionary.
bool	active () const noexcept
	True if source is active.
void	setApplied (const label fieldi)
	Set the applied flag to true for field index fieldi.
bool	active (const bool on) noexcept
	Change source active flag, return previous value.
virtual label	applyToField (const word &fieldName) const
	Return index of field name if found in fieldNames list.
virtual void	checkApplied () const
	Check that the source has been applied.
virtual void	addSup (fvMatrix< symmTensor > &eqn, const label fieldi)
virtual void	addSup (fvMatrix< sphericalTensor > &eqn, const label fieldi)
virtual void	addSup (fvMatrix< tensor > &eqn, const label fieldi)
virtual void	addSup (const volScalarField &rho, fvMatrix< symmTensor > &eqn, const label fieldi)
virtual void	addSup (const volScalarField &rho, fvMatrix< sphericalTensor > &eqn, const label fieldi)
virtual void	addSup (const volScalarField &rho, fvMatrix< tensor > &eqn, const label fieldi)
virtual void	addSup (const volScalarField &alpha, const volScalarField &rho, fvMatrix< scalar > &eqn, const label fieldi)
virtual void	addSup (const volScalarField &alpha, const volScalarField &rho, fvMatrix< vector > &eqn, const label fieldi)
virtual void	addSup (const volScalarField &alpha, const volScalarField &rho, fvMatrix< symmTensor > &eqn, const label fieldi)
virtual void	addSup (const volScalarField &alpha, const volScalarField &rho, fvMatrix< sphericalTensor > &eqn, const label fieldi)
virtual void	addSup (const volScalarField &alpha, const volScalarField &rho, fvMatrix< tensor > &eqn, const label fieldi)
virtual void	constrain (fvMatrix< scalar > &eqn, const label fieldi)
virtual void	constrain (fvMatrix< vector > &eqn, const label fieldi)
virtual void	constrain (fvMatrix< sphericalTensor > &eqn, const label fieldi)
virtual void	constrain (fvMatrix< symmTensor > &eqn, const label fieldi)
virtual void	constrain (fvMatrix< tensor > &eqn, const label fieldi)
virtual void	correct (volScalarField &field)
virtual void	correct (volVectorField &field)
virtual void	correct (volSphericalTensorField &field)
virtual void	correct (volSymmTensorField &field)
virtual void	correct (volTensorField &field)
virtual void	correct (surfaceScalarField &field)
virtual void	correct (surfaceVectorField &field)
virtual void	correct (surfaceTensorField &field)
virtual void	postProcessSens (scalarField &sensField, const word &fieldName=word::null, const word &designVariablesName=word::null)
virtual void	postProcessSens (vectorField &sensField, const word &fieldName=word::null, const word &designVariablesName=word::null)
virtual void	postProcessSens (tensorField &sensField, const word &fieldName=word::null, const word &designVariablesName=word::null)
virtual void	postProcessAuxSens (const volScalarField &primalField, const volScalarField &adjointField, scalarField &sensField, const word &fieldName=word::null)
virtual void	postProcessAuxSens (const volVectorField &primalField, const volVectorField &adjointField, scalarField &sensField, const word &fieldName=word::null)
virtual void	postProcessAuxSens (const volTensorField &primalField, const volTensorField &adjointField, scalarField &sensField, const word &fieldName=word::null)
virtual void	writeHeader (Ostream &) const
	Write the source header information.
virtual void	writeFooter (Ostream &) const
	Write the source footer information.
virtual void	writeData (Ostream &) const
	Write the source properties.

Static Public Attributes
static const Enum< thermoMode >	thermoModeTypeNames_
	Names for thermoMode.
Static Public Attributes inherited from cellSetOption
static const Enum< selectionModeType >	selectionModeTypeNames_
	List of selection mode type names.

Additional Inherited Members
Static Public Member Functions inherited from option
static autoPtr< option >	New (const word &name, const dictionary &dict, const fvMesh &mesh)
	Return a reference to the selected fvOption model.
Public Attributes inherited from option
bool	log
	Switch write log to Info.
Protected Member Functions inherited from cellSetOption
void	setSelection (const dictionary &dict)
	Set cell selection name or points selection from dictionary input.
void	setCellSelection ()
	Set the cell selection based on user input selection mode.
void	setVol ()
	Recalculate the volume.
Protected Member Functions inherited from option
void	resetApplied ()
	Resize/reset applied flag list for all fieldNames_ entries.
Protected Attributes inherited from cellSetOption
selectionModeType	selectionMode_
	Cell selection mode.
bool	updateSelection_
	Flag to enable dictionary-based updates of selections.
scalar	timeStart_
	Start time of fvOption.
scalar	duration_
	Duration of fvOption execution starting from timeStart.
wordRes	selectionNames_
	Face selection names (for set or zone selections).
List< point >	points_
	List of points for "points" selectionMode.
PtrList< Function1< point > >	movingPoints_
	List of points for "movingPoints" selectionMode.
dictionary	geometricSelection_
	Dictionary entries for "geometric" (topoSetCellSource) selection.
labelList	cells_
	Set of cells to apply source to.
scalar	V_
	Sum of cell volumes.
Protected Attributes inherited from option
const word	name_
	Source name.
const word	modelType_
	Model type.
const fvMesh &	mesh_
	Reference to the mesh database.
dictionary	dict_
	Top level source dictionary.
dictionary	coeffs_
	Dictionary containing source coefficients.
wordList	fieldNames_
	Field names to apply source to - populated by derived models.
List< bool >	applied_
	Applied flag list - corresponds to each fieldNames_ entry.
bool	active_
	Source active flag.

Detailed Description

This source is designed to model the effect of solidification and melting processes, e.g. windhield defrosting, within a specified region. The phase change occurs at the melting temperature, Tmelt.

The presence of the solid phase in the flow field is incorporated into the model as a momentum porosity contribution; the energy associated with the phase change is added as an enthalpy contribution.

References:

    Voller, V. R., & Prakash, C. (1987).
    A fixed grid numerical modelling methodology for
    convection-diffusion mushy region phase-change problems.
    International Journal of Heat and Mass Transfer, 30(8), 1709-1719.
    DOI:10.1016/0017-9310(87)90317-6

    Swaminathan, C. R., & Voller, V. R. (1992).
    A general enthalpy method for modeling solidification processes.
    Metallurgical transactions B, 23(5), 651-664.
    DOI:10.1007/BF02649725

The model generates a field <name>:alpha1 which can be visualised to to show the melt distribution as a fraction [0-1].

Usage

Minimal example by using constant/fvOptions:

solidificationMeltingSource1
{
    // Mandatory entries (unmodifiable)
    type           solidificationMeltingSource;

    // Mandatory entries (runtime modifiable)
    Tmelt          273;
    L              334000;
    thermoMode     <thermoModeName>;
    rhoRef         800;
    beta           5e-6;

    // Optional entries (runtime modifiable)
    relax          0.9;
    T              <Tname>;
    rho            <rhoName>;
    U              <Uname>;
    phi            <phiName>;
    Cu             1e5;
    q              1e-2;

    // Conditional optional entries (runtime modifiable)

        // when thermoMode=lookup
        Cp         Cp;

    // Conditional mandatory entries (runtime modifiable)

        // when Cp=CpRef
        CpRef  1000;

    // Mandatory/Optional (inherited) entries
    ...
}

where the entries mean:

Property	Description	Type	Reqd	Dflt
`type`	Type name: solidificationMeltingSource	word	yes	-
`Tmelt`	Melting temperature [K]	scalar	yes	-
`L`	Latent heat of fusion [J/kg]	scalar	yes	-
`thermoMode`	Thermo mode	word	yes	-
`rhoRef`	Reference (solid) density	scalar	yes	-
`beta`	Thermal expansion coefficient [1/K]	scalar	yes	-
`relax`	Relaxation factor [0-1]	scakar	no	0.9
`T`	Name of operand temperature field	word	no	T
`rho`	Name of operand density field	word	no	rho
`U`	Name of operand velocity field	word	no	U
`phi`	Name of operand flux field	word	no	phi
`Cu`	Mushy region momentum sink coefficient [1/s]	scalar	no	1e5
`q`	Coefficient used in porosity calc	scalar	no	1e-2
`Cp`	Name of specific heat capacity field	word	cndtnl	Cp
`CpRef`	Specific heat capacity value	scalar	cndtnl	-

The inherited entries are elaborated in:

Options for the thermoMode entry:

      thermo    | Access Cp information from database
      lookup    | Access Cp information by looking up from dictionary

Source files

Definition at line 247 of file solidificationMeltingSource.H.

Member Enumeration Documentation

◆ thermoMode

enum thermoMode

Options for the thermo mode specification.

Enumerator
mdThermo
mdLookup

Definition at line 258 of file solidificationMeltingSource.H.

Constructor & Destructor Documentation

◆ solidificationMeltingSource() [1/2]

solidificationMeltingSource	(	const word &	sourceName,
		const word &	modelType,
		const dictionary &	dict,
		const fvMesh &	mesh )

Construct from explicit source name and mesh.

Definition at line 148 of file solidificationMeltingSource.C.

References Foam::abort(), cellSetOption::cells_, cellSetOption::cellSetOption(), option::coeffs_, dict, basicThermo::dictName, Foam::dimless, Foam::FatalError, FatalErrorInFunction, option::fieldNames_, mdLookup, mdThermo, option::mesh(), option::mesh_, option::name_, option::resetApplied(), thermoModeTypeNames_, timeName, and Foam::Zero.

Referenced by operator=(), and solidificationMeltingSource().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ solidificationMeltingSource() [2/2]

solidificationMeltingSource ( const solidificationMeltingSource & )

delete

No copy construct.

References solidificationMeltingSource().

Here is the call graph for this function:

◆ ~solidificationMeltingSource()

~solidificationMeltingSource ( )

default

Destructor.

References dict, and rho.

Member Function Documentation

◆ TypeName()

TypeName ( "solidificationMeltingSource" )

Runtime type information.

References dict, and option::mesh().

Here is the call graph for this function:

◆ operator=()

void operator= ( const solidificationMeltingSource & )

delete

No copy assignment.

References solidificationMeltingSource().

Here is the call graph for this function:

◆ addSup() [1/4]

void addSup	(	fvMatrix< scalar > &	eqn,
		const label	fieldi )

virtual

Add explicit contribution to enthalpy equation.

Reimplemented from option.

Definition at line 219 of file solidificationMeltingSource.C.

References Foam::apply().

Referenced by addSup().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ addSup() [2/4]

void addSup	(	fvMatrix< vector > &	eqn,
		const label	fieldi )

virtual

Add implicit contribution to momentum equation.

Reimplemented from option.

Definition at line 240 of file solidificationMeltingSource.C.

References cellSetOption::cells_, Cp, lduMatrix::diag(), Foam::endl(), forAll, g, Foam::Info, option::mesh_, IOobject::name(), gravity::New(), Foam::pow3(), fvMatrix< Type >::psi(), fvMatrix< Type >::source(), Foam::Sp(), Foam::sqr(), Foam::Su(), Foam::type(), update(), cellSetOption::V(), and dimensioned< Type >::value().

Here is the call graph for this function:

◆ addSup() [3/4]

void addSup	(	const volScalarField &	rho,
		fvMatrix< scalar > &	eqn,
		const label	fieldi )

virtual

Add explicit contribution to compressible enthalpy equation.

Reimplemented from option.

Definition at line 229 of file solidificationMeltingSource.C.

References Foam::apply(), and rho.

Here is the call graph for this function:

◆ addSup() [4/4]

void addSup	(	const volScalarField &	rho,
		fvMatrix< vector > &	eqn,
		const label	fieldi )

virtual

Add implicit contribution to compressible momentum equation.

Reimplemented from option.

Definition at line 277 of file solidificationMeltingSource.C.

References addSup(), and rho.

Here is the call graph for this function:

◆ read()

bool read ( const dictionary & dict )

virtual

Read source dictionary.

Reimplemented from cellSetOption.

Definition at line 289 of file solidificationMeltingSource.C.

References option::coeffs_, dict, cellSetOption::read(), and thermoModeTypeNames_.

Here is the call graph for this function:

Member Data Documentation

◆ thermoModeTypeNames_

const Foam::Enum< Foam::fv::solidificationMeltingSource::thermoMode > thermoModeTypeNames_

static

Names for thermoMode.

Definition at line 267 of file solidificationMeltingSource.H.

Referenced by read(), and solidificationMeltingSource().

The documentation for this class was generated from the following files:

src/fvOptions/sources/derived/solidificationMeltingSource/solidificationMeltingSource.H
src/fvOptions/sources/derived/solidificationMeltingSource/solidificationMeltingSource.C
src/fvOptions/sources/derived/solidificationMeltingSource/solidificationMeltingSourceTemplates.C

Public Types

Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ thermoMode

Constructor & Destructor Documentation

◆ solidificationMeltingSource() [1/2]

◆ solidificationMeltingSource() [2/2]

◆ ~solidificationMeltingSource()

Member Function Documentation

◆ TypeName()

◆ operator=()

◆ addSup() [1/4]

◆ addSup() [2/4]

◆ addSup() [3/4]

◆ addSup() [4/4]

◆ read()

Member Data Documentation

◆ thermoModeTypeNames_