The electrostaticDeposition is a boundary condition to calculate electric potential (V) on a given boundary based on film thickness (h) and film resistance (R) fields which are updated based on a given patch-normal current density field (jn), Coulombic efficiency and film resistivity. More...

#include <electrostaticDepositionFvPatchScalarField.H>

Inheritance diagram for electrostaticDepositionFvPatchScalarField:

[legend]

Collaboration diagram for electrostaticDepositionFvPatchScalarField:

[legend]

Public Member Functions
	TypeName ("electrostaticDeposition")
	Runtime type information.
	electrostaticDepositionFvPatchScalarField (const fvPatch &, const DimensionedField< scalar, volMesh > &)
	Construct from patch and internal field.
	electrostaticDepositionFvPatchScalarField (const fvPatch &, const DimensionedField< scalar, volMesh > &, const dictionary &)
	Construct from patch, internal field and dictionary.
	electrostaticDepositionFvPatchScalarField (const electrostaticDepositionFvPatchScalarField &, const fvPatch &, const DimensionedField< scalar, volMesh > &, const fvPatchFieldMapper &)
	Construct by mapping given electrostaticDepositionFvPatchScalarField onto a new patch.
	electrostaticDepositionFvPatchScalarField (const electrostaticDepositionFvPatchScalarField &)
	Construct as copy.
	electrostaticDepositionFvPatchScalarField (const electrostaticDepositionFvPatchScalarField &, const DimensionedField< scalar, volMesh > &)
	Construct as copy setting internal field reference.
virtual tmp< fvPatchField< scalar > >	clone () const
	Return a clone.
virtual tmp< fvPatchField< scalar > >	clone (const DimensionedField< scalar, volMesh > &iF) const
	Clone with an internal field reference.
const scalarField &	h () const noexcept
	Return const access to film thickness patch field.
virtual void	autoMap (const fvPatchFieldMapper &)
	Map (and resize as needed) from self given a mapping object.
virtual void	rmap (const fvPatchScalarField &, const labelList &)
	Reverse map the given fvPatchField onto this fvPatchField.
tmp< scalarField >	sigma () const
	Return the isotropic electrical conductivity field of mixture.
virtual void	updateCoeffs ()
	Update the coefficients associated with the patch field.
virtual void	write (Ostream &) const
	Write.

Detailed Description

The electrostaticDeposition is a boundary condition to calculate electric potential (V) on a given boundary based on film thickness (h) and film resistance (R) fields which are updated based on a given patch-normal current density field (jn), Coulombic efficiency and film resistivity.

$\‍[ j_n = - \sigma \nabla^\perp_p V = - \sigma (\vec{n}\cdot(\nabla V)_p) \‍]$

$\‍[ \frac{dh}{dt} = C_{eff} (j_n - j_{min}) \‍]$

$\‍[ \frac{dR}{dt} = \rho \frac{dh}{dt} = \rho C_{eff} (j_n - j_{min}) \‍]$

$\‍[ V_{film}^n = V_{film}^o + j_n R_\Delta \‍]$

$\‍[ V_{body} = j_n R_{body} \‍]$

$\‍[ V_p^n = V_i + V_{body} + V_{film}^n \‍]$

where

	=	Patch-normal current density [A/m^2]
	=	Electric potential on film-fluid interface [volt = kg m^2/(A s^3)]
	=	Previous time-step electric potential on the interface [volt]
$V_{film}$	=	Electric potential due to film resistance [volt]
$V_{body}$	=	Electric potential due to body resistance [volt]
	=	Initial electric potential [volt]
$R_\Delta$	=	Film resistance (finite increment) [ohm m^2 = kg m^4/(A^2 s^3)]
$R_{body}$	=	Body resistance [ohm m^2 = kg m^4/(A^2 s^3)]
$\rho$	=	Isotropic film resistivity [ohm m = kg m^3/(A^2 s^3)]
	=	Film thickness [m]
$C_{eff}$	=	Volumetric Coulombic efficiency [m^3/(A s)]
$j_{min}$	=	Minimum current density for deposition onset [A/m^2]
$\sigma$	=	Isotropic conductivity of mixture [S/m = A^2 s^3/(kg m^3)]
$\vec{n}$	=	Patch-normal unit vector [-]

Usage

Example of the boundary condition specification:

<patchName>
{
    // Mandatory entries
    type                    electrostaticDeposition;
    h                       <scalarField>;
    CoulombicEfficiency     <PatchFunction1>;
    resistivity             <PatchFunction1>;

    // Conditional mandatory entries

        // Option-1: single-phase
        sigma       <scalar>;

        // Option-2: multiphase
        phases
        {
            alpha.air
            {
                sigma       <scalar>;
            }
            alpha.water
            {
                sigma       <scalar>;
            }
            alpha.mercury
            {
                sigma       <scalar>;
            }
            ...
        }

    // Optional entries
    jMin                    <scalar>;
    qMin                    <scalar>;
    Rbody                   <scalar>;
    Vi                      <scalar>;
    Vanode                  <scalar>;
    qCumulative             <scalarField>;

    // Inherited entries
    ...
}

where the entries mean:

Property	Description	Type	Reqd	Deflt
`type`	Type name: electrostaticDeposition	word	yes	-
`h`	Film thickness	scalarField	yes	-
`CoulombicEfficiency`	Coulombic efficiency	PatchFunction1<scalar>	yes	-
`resistivity`	Isotropic film resistivity	PatchFunction1<scalar>	yes	-
`sigma`	Isotropic electrical conductivity of phase	scalar	yes	-
`jMin`	Minimum current density for deposition onset	scalar	no	0
`qMin`	Minimum accumulative specific charge for deposition onset	scalar	no	0
`Rbody`	Resistance due to main body and/or pretreatment layers	scalar	no	0
`Vi`	Initial electric potential	scalar	no	0
`Vanode`	Anode electric potential	scalar	no	GREAT
`qCumulative`	Accumulative specific charge [A s/m^2]	scalarField	no	0

The inherited entries are elaborated in:

Note

Depletion or abrasion of material due to negative current is not allowed.
When accumulative specific charge (qCumulative) is less than minimum accumulative specific charge (qMin), no deposition occurs.
Boundary-condition updates are not allowed during outer corrections to prevent spurious accumulation of film thickness.
resistivity, jMin, qMin and Rbody are always non-negative.

Source files

Definition at line 315 of file electrostaticDepositionFvPatchScalarField.H.

Constructor & Destructor Documentation

◆ electrostaticDepositionFvPatchScalarField() [1/5]

electrostaticDepositionFvPatchScalarField	(	const fvPatch &	p,
		const DimensionedField< scalar, volMesh > &	iF )

Construct from patch and internal field.

Definition at line 132 of file electrostaticDepositionFvPatchScalarField.C.

References Foam::dimCurrent, Foam::dimLength, Foam::dimMass, Foam::dimTime, p, Foam::pow3(), and Foam::sqr().

Referenced by electrostaticDepositionFvPatchScalarField(), electrostaticDepositionFvPatchScalarField(), electrostaticDepositionFvPatchScalarField(), and TypeName().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ electrostaticDepositionFvPatchScalarField() [2/5]

electrostaticDepositionFvPatchScalarField	(	const fvPatch &	p,
		const DimensionedField< scalar, volMesh > &	iF,
		const dictionary &	dict )

Construct from patch, internal field and dictionary.

Definition at line 160 of file electrostaticDepositionFvPatchScalarField.C.

References dict, Foam::dimCurrent, Foam::dimLength, Foam::dimMass, Foam::dimTime, forAll, Foam::New(), p, Foam::pow3(), and Foam::sqr().

Here is the call graph for this function:

◆ electrostaticDepositionFvPatchScalarField() [3/5]

electrostaticDepositionFvPatchScalarField	(	const electrostaticDepositionFvPatchScalarField &	ptf,
		const fvPatch &	p,
		const DimensionedField< scalar, volMesh > &	iF,
		const fvPatchFieldMapper &	mapper )

Construct by mapping given electrostaticDepositionFvPatchScalarField onto a new patch.

Definition at line 259 of file electrostaticDepositionFvPatchScalarField.C.

References clone(), electrostaticDepositionFvPatchScalarField(), and p.

Here is the call graph for this function:

◆ electrostaticDepositionFvPatchScalarField() [4/5]

electrostaticDepositionFvPatchScalarField ( const electrostaticDepositionFvPatchScalarField & ptf )

Construct as copy.

Definition at line 289 of file electrostaticDepositionFvPatchScalarField.C.

References clone(), and electrostaticDepositionFvPatchScalarField().

Here is the call graph for this function:

◆ electrostaticDepositionFvPatchScalarField() [5/5]

electrostaticDepositionFvPatchScalarField	(	const electrostaticDepositionFvPatchScalarField &	ptf,
		const DimensionedField< scalar, volMesh > &	iF )

Construct as copy setting internal field reference.

Definition at line 316 of file electrostaticDepositionFvPatchScalarField.C.

References clone(), and electrostaticDepositionFvPatchScalarField().

Here is the call graph for this function:

Member Function Documentation

◆ TypeName()

TypeName ( "electrostaticDeposition" )

Runtime type information.

References electrostaticDepositionFvPatchScalarField().

Here is the call graph for this function:

◆ clone() [1/2]

virtual tmp< fvPatchField< scalar > > clone ( ) const

inlinevirtual

Return a clone.

Definition at line 504 of file electrostaticDepositionFvPatchScalarField.H.

References fvPatchField< Type >::Clone().

Referenced by electrostaticDepositionFvPatchScalarField(), electrostaticDepositionFvPatchScalarField(), and electrostaticDepositionFvPatchScalarField().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ clone() [2/2]

virtual tmp< fvPatchField< scalar > > clone ( const DimensionedField< scalar, volMesh > & iF ) const

inlinevirtual

Clone with an internal field reference.

Definition at line 512 of file electrostaticDepositionFvPatchScalarField.H.

References fvPatchField< Type >::Clone().

Here is the call graph for this function:

◆ h()

const scalarField & h ( ) const

inlinenoexcept

Return const access to film thickness patch field.

Definition at line 528 of file electrostaticDepositionFvPatchScalarField.H.

References Foam::noexcept.

◆ autoMap()

void autoMap ( const fvPatchFieldMapper & m )

virtual

Map (and resize as needed) from self given a mapping object.

Definition at line 346 of file electrostaticDepositionFvPatchScalarField.C.

◆ rmap()

void rmap	(	const fvPatchScalarField &	ptf,
		const labelList &	addr )

virtual

Reverse map the given fvPatchField onto this fvPatchField.

Definition at line 369 of file electrostaticDepositionFvPatchScalarField.C.

References Foam::refCast().

Here is the call graph for this function:

◆ sigma()

Foam::tmp< Foam::scalarField > sigma ( ) const

Return the isotropic electrical conductivity field of mixture.

Definition at line 397 of file electrostaticDepositionFvPatchScalarField.C.

References tmp< T >::New(), and tmp< T >::ref().

Here is the call graph for this function:

◆ updateCoeffs()

void updateCoeffs ( )

virtual

Update the coefficients associated with the patch field.

Definition at line 419 of file electrostaticDepositionFvPatchScalarField.C.

References Foam::endl(), forAll, Foam::gAverage(), Foam::gMinMax(), Foam::Info, limits, UPstream::master(), Foam::max(), Foam::min(), Foam::nl, Foam::operator==(), tmp< T >::ref(), sigma(), and timeIndex.

Here is the call graph for this function:

◆ write()

void write ( Ostream & os ) const

virtual

Write.

Definition at line 519 of file electrostaticDepositionFvPatchScalarField.C.

References os(), fvPatchField< Type >::write(), and fvPatchField< Type >::writeValueEntry().

Here is the call graph for this function:

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

src/finiteVolume/fields/fvPatchFields/derived/electrostaticDeposition/electrostaticDepositionFvPatchScalarField.H
src/finiteVolume/fields/fvPatchFields/derived/electrostaticDeposition/electrostaticDepositionFvPatchScalarField.C

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ electrostaticDepositionFvPatchScalarField() [1/5]

◆ electrostaticDepositionFvPatchScalarField() [2/5]

◆ electrostaticDepositionFvPatchScalarField() [3/5]

◆ electrostaticDepositionFvPatchScalarField() [4/5]

◆ electrostaticDepositionFvPatchScalarField() [5/5]

Member Function Documentation

◆ TypeName()

◆ clone() [1/2]

◆ clone() [2/2]

◆ h()

◆ autoMap()

◆ rmap()

◆ sigma()

◆ updateCoeffs()

◆ write()