Foam::regionModels::surfaceFilmModels Namespace Reference

Classes
class	ArrheniusViscosity
	The Arrhenius temperature-dependent viscosity model multiplies the viscosity of a base model by an Arrhenius-type temperature function: More...
class	BrunDrippingEjection
	Film Dripping mass transfer model. More...
class	constantHeatTransfer
	Constant heat transfer model. More...
class	constantRadiation
	Film constant radiation model. The constant radiative flux is specified by the user, and operated over a time interval defined by a start time and duration. In addition, a mask can be applied to shield the film from the radiation. More...
class	constantViscosity
	Constant viscosity model. More...
class	contactAngleForce
	Base-class for film contact angle force models. More...
class	curvatureSeparation
	Curvature film separation model. More...
class	distributionContactAngleForce
	PDF distribution based film contact angle force. More...
class	drippingEjection
	Film Dripping mass transfer model. More...
class	ejectionModel
	Base class for film ejection models, handling mass transfer from the film. More...
class	ejectionModelList
	List container for film ejection models. More...
class	filmSubModelBase
	Base class for surface film sub-models. More...
class	force
	Base class for film (stress-based) force models. More...
class	forceList
	List container for film sources. More...
class	function1Viscosity
	The Foam::Function1 temperature-dependent viscosity model multiplies the viscosity of a base model by a Function1 temperature function. More...
class	heatTransferModel
	Base class for film heat transfer models. More...
class	kinematicSingleLayer
	Kinematic form of single-cell layer surface film model. More...
class	laminar
	Film laminar momentum transport model. More...
class	mappedConvectiveHeatTransfer
	Convective heat transfer model based on a re-working of a Nusselt number correlation. More...
class	momentumTransportModel
	Base class for film momentum transport models. More...
class	NewtonianViscosity
	Newtonian viscosity model with the viscosity obtain directly from the thermophysical properties. More...
class	noFilm
	Dummy surfaceFilmModel to allow solvers supporting film simulations to be run without a film region. More...
class	noPhaseChange
	Dummy phase change model for 'none'. More...
class	noRadiation
	Dummy radiation model for 'none' option. More...
class	patchEjection
	Remove and eject the mass in the film as it passes over the selected patches. More...
class	perturbedTemperatureDependentContactAngleForce
	Temperature dependent contact angle force with a stochastic perturbation. More...
class	phaseChangeModel
	Base class for surface film phase change models. More...
class	primaryRadiation
	Radiation model whereby the radiative heat flux is mapped from the primary region. More...
class	radiationModel
	Base class for film radiation models. More...
class	solidification
	Solidification phase change model where all film mass is converted when the local temperature > activation temperature. The latent heat is assumed to be removed by heat-transfer to the wall. More...
class	speciePhaseChange
	Specie phase change model abstract base class. More...
class	standardPhaseChange
	Standard phase change model with modification for boiling. More...
class	standardRadiation
	Standard radiation model. More...
class	surfaceFilmRegionModel
	Base class for surface film models. More...
class	temperatureDependentContactAngleForce
	Temperature dependent contact angle force. More...
class	thermocapillaryForce
	Thermocapillary force. More...
class	thermoSingleLayer
	Thermodynamic form of single-cell layer surface film model. More...
class	thixotropicViscosity
	Thixotropic viscosity model based on the evolution of the structural parameter : More...
class	transferModel
	Base class for film transfer models, handling mass transfer between the film and the continuous phase. More...
class	transferModelList
	List container for film transfer models. More...
class	viscosityModel
	Base class for surface film viscosity models. More...
class	VoFPatchTransfer
	Transfer mass between the film and the VoF in the continuous phase. More...
class	waxSolventEvaporation
	Wax solvent mixture evaporation model. More...
class	waxSolventViscosity
	Wax solvent mixture viscosity model. More...

Functions
	defineTypeNameAndDebug (kinematicSingleLayer, 0)
	defineTypeNameAndDebug (noFilm, 0)
	addToRunTimeSelectionTable (surfaceFilmModel, noFilm, mesh)
	defineTypeNameAndDebug (BrunDrippingEjection, 0)
	addToRunTimeSelectionTable (ejectionModel, BrunDrippingEjection, dictionary)
	defineTypeNameAndDebug (curvatureSeparation, 0)
	addToRunTimeSelectionTable (ejectionModel, curvatureSeparation, dictionary)
	defineTypeNameAndDebug (drippingEjection, 0)
	addToRunTimeSelectionTable (ejectionModel, drippingEjection, dictionary)
	defineTypeNameAndDebug (ejectionModel, 0)
	defineRunTimeSelectionTable (ejectionModel, dictionary)
	defineTypeNameAndDebug (patchEjection, 0)
	addToRunTimeSelectionTable (ejectionModel, patchEjection, dictionary)
	defineTypeNameAndDebug (momentumTransportModel, 0)
	defineRunTimeSelectionTable (momentumTransportModel, dictionary)
	defineTypeNameAndDebug (laminar, 0)
	addToRunTimeSelectionTable (momentumTransportModel, laminar, dictionary)
	defineTypeNameAndDebug (ArrheniusViscosity, 0)
	addToRunTimeSelectionTable (viscosityModel, ArrheniusViscosity, dictionary)
	defineTypeNameAndDebug (constantViscosity, 0)
	addToRunTimeSelectionTable (viscosityModel, constantViscosity, dictionary)
	defineTypeNameAndDebug (viscosityModel, 0)
	defineRunTimeSelectionTable (viscosityModel, dictionary)
	defineTypeNameAndDebug (function1Viscosity, 0)
	addToRunTimeSelectionTable (viscosityModel, function1Viscosity, dictionary)
	defineTypeNameAndDebug (NewtonianViscosity, 0)
	addToRunTimeSelectionTable (viscosityModel, NewtonianViscosity, dictionary)
	defineTypeNameAndDebug (thixotropicViscosity, 0)
	addToRunTimeSelectionTable (viscosityModel, thixotropicViscosity, dictionary)
	defineTypeNameAndDebug (waxSolventViscosity, 0)
	addToRunTimeSelectionTable (viscosityModel, waxSolventViscosity, dictionary)
	defineTypeNameAndDebug (contactAngleForce, 0)
	defineTypeNameAndDebug (distributionContactAngleForce, 0)
	addToRunTimeSelectionTable (force, distributionContactAngleForce, dictionary)
	defineTypeNameAndDebug (perturbedTemperatureDependentContactAngleForce, 0)
	addToRunTimeSelectionTable (force, perturbedTemperatureDependentContactAngleForce, dictionary)
	defineTypeNameAndDebug (temperatureDependentContactAngleForce, 0)
	addToRunTimeSelectionTable (force, temperatureDependentContactAngleForce, dictionary)
	defineTypeNameAndDebug (force, 0)
	defineRunTimeSelectionTable (force, dictionary)
	defineTypeNameAndDebug (thermocapillaryForce, 0)
	addToRunTimeSelectionTable (force, thermocapillaryForce, dictionary)
	defineTypeNameAndDebug (transferModel, 0)
	defineRunTimeSelectionTable (transferModel, dictionary)
	defineTypeNameAndDebug (constantRadiation, 0)
	addToRunTimeSelectionTable (radiationModel, constantRadiation, dictionary)
	defineTypeNameAndDebug (radiationModel, 0)
	defineRunTimeSelectionTable (radiationModel, dictionary)
	defineTypeNameAndDebug (noRadiation, 0)
	addToRunTimeSelectionTable (radiationModel, noRadiation, dictionary)
	defineTypeNameAndDebug (primaryRadiation, 0)
	addToRunTimeSelectionTable (radiationModel, primaryRadiation, dictionary)
	defineTypeNameAndDebug (standardRadiation, 0)
	addToRunTimeSelectionTable (radiationModel, standardRadiation, dictionary)
	defineTypeNameAndDebug (constantHeatTransfer, 0)
	addToRunTimeSelectionTable (heatTransferModel, constantHeatTransfer, dictionary)
	defineTypeNameAndDebug (heatTransferModel, 0)
	defineRunTimeSelectionTable (heatTransferModel, dictionary)
	defineTypeNameAndDebug (mappedConvectiveHeatTransfer, 0)
	addToRunTimeSelectionTable (heatTransferModel, mappedConvectiveHeatTransfer, dictionary)
	defineTypeNameAndDebug (noPhaseChange, 0)
	addToRunTimeSelectionTable (phaseChangeModel, noPhaseChange, dictionary)
	defineTypeNameAndDebug (phaseChangeModel, 0)
	defineRunTimeSelectionTable (phaseChangeModel, dictionary)
	defineTypeNameAndDebug (solidification, 0)
	addToRunTimeSelectionTable (phaseChangeModel, solidification, dictionary)
	defineTypeNameAndDebug (speciePhaseChange, 0)
	defineTypeNameAndDebug (standardPhaseChange, 0)
	addToRunTimeSelectionTable (phaseChangeModel, standardPhaseChange, dictionary)
	defineTypeNameAndDebug (waxSolventEvaporation, 0)
	addToRunTimeSelectionTable (phaseChangeModel, waxSolventEvaporation, dictionary)
	defineTypeNameAndDebug (surfaceFilmRegionModel, 0)
	defineTypeNameAndDebug (thermoSingleLayer, 0)
	addToRunTimeSelectionTable (surfaceFilmRegionModel, thermoSingleLayer, mesh)

Function Documentation

defineTypeNameAndDebug() [1/39]

Foam::regionModels::surfaceFilmModels::defineTypeNameAndDebug	(	kinematicSingleLayer	,
		0
	)

defineTypeNameAndDebug() [2/39]

Foam::regionModels::surfaceFilmModels::defineTypeNameAndDebug	(	noFilm	,
		0
	)

addToRunTimeSelectionTable() [1/27]

Foam::regionModels::surfaceFilmModels::addToRunTimeSelectionTable	(	surfaceFilmModel	,
		noFilm	,
		mesh
	)

defineTypeNameAndDebug() [3/39]

Foam::regionModels::surfaceFilmModels::defineTypeNameAndDebug	(	BrunDrippingEjection	,
		0
	)

addToRunTimeSelectionTable() [2/27]

Foam::regionModels::surfaceFilmModels::addToRunTimeSelectionTable	(	ejectionModel	,
		BrunDrippingEjection	,
		dictionary
	)

defineTypeNameAndDebug() [4/39]

Foam::regionModels::surfaceFilmModels::defineTypeNameAndDebug	(	curvatureSeparation	,
		0
	)

addToRunTimeSelectionTable() [3/27]

Foam::regionModels::surfaceFilmModels::addToRunTimeSelectionTable	(	ejectionModel	,
		curvatureSeparation	,
		dictionary
	)

defineTypeNameAndDebug() [5/39]

Foam::regionModels::surfaceFilmModels::defineTypeNameAndDebug	(	drippingEjection	,
		0
	)

addToRunTimeSelectionTable() [4/27]

Foam::regionModels::surfaceFilmModels::addToRunTimeSelectionTable	(	ejectionModel	,
		drippingEjection	,
		dictionary
	)

defineTypeNameAndDebug() [6/39]

Foam::regionModels::surfaceFilmModels::defineTypeNameAndDebug	(	ejectionModel	,
		0
	)

defineRunTimeSelectionTable() [1/8]

Foam::regionModels::surfaceFilmModels::defineRunTimeSelectionTable	(	ejectionModel	,
		dictionary
	)

defineTypeNameAndDebug() [7/39]

Foam::regionModels::surfaceFilmModels::defineTypeNameAndDebug	(	patchEjection	,
		0
	)

addToRunTimeSelectionTable() [5/27]

Foam::regionModels::surfaceFilmModels::addToRunTimeSelectionTable	(	ejectionModel	,
		patchEjection	,
		dictionary
	)

defineTypeNameAndDebug() [8/39]

Foam::regionModels::surfaceFilmModels::defineTypeNameAndDebug	(	momentumTransportModel	,
		0
	)

defineRunTimeSelectionTable() [2/8]

Foam::regionModels::surfaceFilmModels::defineRunTimeSelectionTable	(	momentumTransportModel	,
		dictionary
	)

defineTypeNameAndDebug() [9/39]

Foam::regionModels::surfaceFilmModels::defineTypeNameAndDebug	(	laminar	,
		0
	)

addToRunTimeSelectionTable() [6/27]

Foam::regionModels::surfaceFilmModels::addToRunTimeSelectionTable	(	momentumTransportModel	,
		laminar	,
		dictionary
	)

defineTypeNameAndDebug() [10/39]

Foam::regionModels::surfaceFilmModels::defineTypeNameAndDebug	(	ArrheniusViscosity	,
		0
	)

addToRunTimeSelectionTable() [7/27]

Foam::regionModels::surfaceFilmModels::addToRunTimeSelectionTable	(	viscosityModel	,
		ArrheniusViscosity	,
		dictionary
	)

defineTypeNameAndDebug() [11/39]

Foam::regionModels::surfaceFilmModels::defineTypeNameAndDebug	(	constantViscosity	,
		0
	)

addToRunTimeSelectionTable() [8/27]

Foam::regionModels::surfaceFilmModels::addToRunTimeSelectionTable	(	viscosityModel	,
		constantViscosity	,
		dictionary
	)

defineTypeNameAndDebug() [12/39]

Foam::regionModels::surfaceFilmModels::defineTypeNameAndDebug	(	viscosityModel	,
		0
	)

defineRunTimeSelectionTable() [3/8]

Foam::regionModels::surfaceFilmModels::defineRunTimeSelectionTable	(	viscosityModel	,
		dictionary
	)

defineTypeNameAndDebug() [13/39]

Foam::regionModels::surfaceFilmModels::defineTypeNameAndDebug	(	function1Viscosity	,
		0
	)

addToRunTimeSelectionTable() [9/27]

Foam::regionModels::surfaceFilmModels::addToRunTimeSelectionTable	(	viscosityModel	,
		function1Viscosity	,
		dictionary
	)

defineTypeNameAndDebug() [14/39]

Foam::regionModels::surfaceFilmModels::defineTypeNameAndDebug	(	NewtonianViscosity	,
		0
	)

addToRunTimeSelectionTable() [10/27]

Foam::regionModels::surfaceFilmModels::addToRunTimeSelectionTable	(	viscosityModel	,
		NewtonianViscosity	,
		dictionary
	)

defineTypeNameAndDebug() [15/39]

Foam::regionModels::surfaceFilmModels::defineTypeNameAndDebug	(	thixotropicViscosity	,
		0
	)

addToRunTimeSelectionTable() [11/27]

Foam::regionModels::surfaceFilmModels::addToRunTimeSelectionTable	(	viscosityModel	,
		thixotropicViscosity	,
		dictionary
	)

defineTypeNameAndDebug() [16/39]

Foam::regionModels::surfaceFilmModels::defineTypeNameAndDebug	(	waxSolventViscosity	,
		0
	)

addToRunTimeSelectionTable() [12/27]

Foam::regionModels::surfaceFilmModels::addToRunTimeSelectionTable	(	viscosityModel	,
		waxSolventViscosity	,
		dictionary
	)

defineTypeNameAndDebug() [17/39]

Foam::regionModels::surfaceFilmModels::defineTypeNameAndDebug	(	contactAngleForce	,
		0
	)

defineTypeNameAndDebug() [18/39]

Foam::regionModels::surfaceFilmModels::defineTypeNameAndDebug	(	distributionContactAngleForce	,
		0
	)

addToRunTimeSelectionTable() [13/27]

Foam::regionModels::surfaceFilmModels::addToRunTimeSelectionTable	(	force	,
		distributionContactAngleForce	,
		dictionary
	)

defineTypeNameAndDebug() [19/39]

Foam::regionModels::surfaceFilmModels::defineTypeNameAndDebug	(	perturbedTemperatureDependentContactAngleForce	,
		0
	)

addToRunTimeSelectionTable() [14/27]

Foam::regionModels::surfaceFilmModels::addToRunTimeSelectionTable	(	force	,
		perturbedTemperatureDependentContactAngleForce	,
		dictionary
	)

defineTypeNameAndDebug() [20/39]

Foam::regionModels::surfaceFilmModels::defineTypeNameAndDebug	(	temperatureDependentContactAngleForce	,
		0
	)

addToRunTimeSelectionTable() [15/27]

Foam::regionModels::surfaceFilmModels::addToRunTimeSelectionTable	(	force	,
		temperatureDependentContactAngleForce	,
		dictionary
	)

defineTypeNameAndDebug() [21/39]

Foam::regionModels::surfaceFilmModels::defineTypeNameAndDebug	(	force	,
		0
	)

defineRunTimeSelectionTable() [4/8]

Foam::regionModels::surfaceFilmModels::defineRunTimeSelectionTable	(	force	,
		dictionary
	)

defineTypeNameAndDebug() [22/39]

Foam::regionModels::surfaceFilmModels::defineTypeNameAndDebug	(	thermocapillaryForce	,
		0
	)

addToRunTimeSelectionTable() [16/27]

Foam::regionModels::surfaceFilmModels::addToRunTimeSelectionTable	(	force	,
		thermocapillaryForce	,
		dictionary
	)

defineTypeNameAndDebug() [23/39]

Foam::regionModels::surfaceFilmModels::defineTypeNameAndDebug	(	transferModel	,
		0
	)

defineRunTimeSelectionTable() [5/8]

Foam::regionModels::surfaceFilmModels::defineRunTimeSelectionTable	(	transferModel	,
		dictionary
	)

defineTypeNameAndDebug() [24/39]

Foam::regionModels::surfaceFilmModels::defineTypeNameAndDebug	(	constantRadiation	,
		0
	)

addToRunTimeSelectionTable() [17/27]

Foam::regionModels::surfaceFilmModels::addToRunTimeSelectionTable	(	radiationModel	,
		constantRadiation	,
		dictionary
	)

defineTypeNameAndDebug() [25/39]

Foam::regionModels::surfaceFilmModels::defineTypeNameAndDebug	(	radiationModel	,
		0
	)

defineRunTimeSelectionTable() [6/8]

Foam::regionModels::surfaceFilmModels::defineRunTimeSelectionTable	(	radiationModel	,
		dictionary
	)

defineTypeNameAndDebug() [26/39]

Foam::regionModels::surfaceFilmModels::defineTypeNameAndDebug	(	noRadiation	,
		0
	)

addToRunTimeSelectionTable() [18/27]

Foam::regionModels::surfaceFilmModels::addToRunTimeSelectionTable	(	radiationModel	,
		noRadiation	,
		dictionary
	)

defineTypeNameAndDebug() [27/39]

Foam::regionModels::surfaceFilmModels::defineTypeNameAndDebug	(	primaryRadiation	,
		0
	)

addToRunTimeSelectionTable() [19/27]

Foam::regionModels::surfaceFilmModels::addToRunTimeSelectionTable	(	radiationModel	,
		primaryRadiation	,
		dictionary
	)

defineTypeNameAndDebug() [28/39]

Foam::regionModels::surfaceFilmModels::defineTypeNameAndDebug	(	standardRadiation	,
		0
	)

addToRunTimeSelectionTable() [20/27]

Foam::regionModels::surfaceFilmModels::addToRunTimeSelectionTable	(	radiationModel	,
		standardRadiation	,
		dictionary
	)

defineTypeNameAndDebug() [29/39]

Foam::regionModels::surfaceFilmModels::defineTypeNameAndDebug	(	constantHeatTransfer	,
		0
	)

addToRunTimeSelectionTable() [21/27]

Foam::regionModels::surfaceFilmModels::addToRunTimeSelectionTable	(	heatTransferModel	,
		constantHeatTransfer	,
		dictionary
	)

defineTypeNameAndDebug() [30/39]

Foam::regionModels::surfaceFilmModels::defineTypeNameAndDebug	(	heatTransferModel	,
		0
	)

defineRunTimeSelectionTable() [7/8]

Foam::regionModels::surfaceFilmModels::defineRunTimeSelectionTable	(	heatTransferModel	,
		dictionary
	)

defineTypeNameAndDebug() [31/39]

Foam::regionModels::surfaceFilmModels::defineTypeNameAndDebug	(	mappedConvectiveHeatTransfer	,
		0
	)

addToRunTimeSelectionTable() [22/27]

Foam::regionModels::surfaceFilmModels::addToRunTimeSelectionTable	(	heatTransferModel	,
		mappedConvectiveHeatTransfer	,
		dictionary
	)

defineTypeNameAndDebug() [32/39]

Foam::regionModels::surfaceFilmModels::defineTypeNameAndDebug	(	noPhaseChange	,
		0
	)

addToRunTimeSelectionTable() [23/27]

Foam::regionModels::surfaceFilmModels::addToRunTimeSelectionTable	(	phaseChangeModel	,
		noPhaseChange	,
		dictionary
	)

defineTypeNameAndDebug() [33/39]

Foam::regionModels::surfaceFilmModels::defineTypeNameAndDebug	(	phaseChangeModel	,
		0
	)

defineRunTimeSelectionTable() [8/8]

Foam::regionModels::surfaceFilmModels::defineRunTimeSelectionTable	(	phaseChangeModel	,
		dictionary
	)

defineTypeNameAndDebug() [34/39]

Foam::regionModels::surfaceFilmModels::defineTypeNameAndDebug	(	solidification	,
		0
	)

addToRunTimeSelectionTable() [24/27]

Foam::regionModels::surfaceFilmModels::addToRunTimeSelectionTable	(	phaseChangeModel	,
		solidification	,
		dictionary
	)

defineTypeNameAndDebug() [35/39]

Foam::regionModels::surfaceFilmModels::defineTypeNameAndDebug	(	speciePhaseChange	,
		0
	)

defineTypeNameAndDebug() [36/39]

Foam::regionModels::surfaceFilmModels::defineTypeNameAndDebug	(	standardPhaseChange	,
		0
	)

addToRunTimeSelectionTable() [25/27]

Foam::regionModels::surfaceFilmModels::addToRunTimeSelectionTable	(	phaseChangeModel	,
		standardPhaseChange	,
		dictionary
	)

defineTypeNameAndDebug() [37/39]

Foam::regionModels::surfaceFilmModels::defineTypeNameAndDebug	(	waxSolventEvaporation	,
		0
	)

addToRunTimeSelectionTable() [26/27]

Foam::regionModels::surfaceFilmModels::addToRunTimeSelectionTable	(	phaseChangeModel	,
		waxSolventEvaporation	,
		dictionary
	)

defineTypeNameAndDebug() [38/39]

Foam::regionModels::surfaceFilmModels::defineTypeNameAndDebug	(	surfaceFilmRegionModel	,
		0
	)

defineTypeNameAndDebug() [39/39]

Foam::regionModels::surfaceFilmModels::defineTypeNameAndDebug	(	thermoSingleLayer	,
		0
	)

addToRunTimeSelectionTable() [27/27]

Foam::regionModels::surfaceFilmModels::addToRunTimeSelectionTable	(	surfaceFilmRegionModel	,
		thermoSingleLayer	,
		mesh
	)