Computes the steady-state equation of charge conservation to obtain the electric potential by strictly assuming a quasi-static electrostatic field for single-phase and multiphase applications. More...
Public Member Functions | |
| TypeName ("electricPotential") | |
| Runtime type information. More... | |
| electricPotential (const word &name, const Time &runTime, const dictionary &dict) | |
| Construct from Time and dictionary. More... | |
| virtual | ~electricPotential ()=default |
| Destructor. More... | |
| virtual bool | read (const dictionary &dict) |
| Read the function object data. More... | |
| virtual bool | execute () |
| Calculate the function object. More... | |
| virtual bool | write () |
| Write the function object output. More... | |
 Public Member Functions inherited from fvMeshFunctionObject | |
| TypeName ("fvMeshFunctionObject") | |
| Runtime type information. More... | |
| fvMeshFunctionObject (const word &name, const Time &runTime, const dictionary &dict) | |
| Construct from Time and dictionary. More... | |
| fvMeshFunctionObject (const word &name, const objectRegistry &obr, const dictionary &dict) | |
| Construct from the region objectRegistry and dictionary. More... | |
| virtual | ~fvMeshFunctionObject ()=default |
| Destructor. More... | |
| Public Member Functions inherited from regionFunctionObject | |
| TypeName ("regionFunctionObject") | |
| Runtime type information. More... | |
| regionFunctionObject (const word &name, const Time &runTime, const dictionary &dict) | |
| Construct from Time and dictionary. More... | |
| regionFunctionObject (const word &name, const objectRegistry &obr, const dictionary &dict) | |
| Construct from the region objectRegistry and dictionary. More... | |
| virtual | ~regionFunctionObject ()=default |
| Destructor. More... | |
| template<class ObjectType > | |
| const ObjectType * | lookupObjectPtr (const word &fieldName) const |
| Deprecated(2018-10) More... | |
| template<class ObjectType > | |
| ObjectType * | lookupObjectRefPtr (const word &fieldName) const |
| Deprecated(2018-10) More... | |
| Public Member Functions inherited from stateFunctionObject | |
| stateFunctionObject (const word &name, const Time &runTime) | |
| Construct from components. More... | |
| virtual | ~stateFunctionObject ()=default |
| Destructor. More... | |
| dictionary & | propertyDict () |
| Return access to the property dictionary. More... | |
| bool | foundProperty (const word &entryName) const |
| Return true if the property exists. More... | |
| void | clearTrigger () |
| Remove the trigger index from the properties. More... | |
| label | getTrigger () const |
| Get the current trigger index. More... | |
| bool | setTrigger (const label triggeri) |
| Set new trigger index. More... | |
| bool | getDict (const word &entryName, dictionary &dict) const |
| Set dictionary, return true if set. More... | |
| bool | getObjectDict (const word &objectName, const word &entryName, dictionary &dict) const |
| Set dictionary from named object, return true if set. More... | |
| template<class Type > | |
| Type | getProperty (const word &entryName, const Type &defaultValue=Type(Zero)) const |
| Retrieve generic property. More... | |
| template<class Type > | |
| bool | getProperty (const word &entryName, Type &value) const |
| Set generic property, return true if set. More... | |
| template<class Type > | |
| void | setProperty (const word &entryName, const Type &value) |
| Add generic property. More... | |
| template<class Type > | |
| Type | getObjectProperty (const word &objectName, const word &entryName, const Type &defaultValue=Type(Zero)) const |
| Retrieve generic property from named object. More... | |
| template<class Type > | |
| bool | getObjectProperty (const word &objectName, const word &entryName, Type &value) const |
| Set generic property from named object, return true if set. More... | |
| template<class Type > | |
| void | setObjectProperty (const word &objectName, const word &entryName, const Type &value) |
| Add generic property from named object. More... | |
| bool | getObjectResultDict (const word &objectName, dictionary &dict) const |
| template<class Type > | |
| void | setResult (const word &entryName, const Type &value) |
| Add result. More... | |
| template<class Type > | |
| void | setObjectResult (const word &objectName, const word &entryName, const Type &value) |
| Add result from named object. More... | |
| template<class Type > | |
| Type | getResult (const word &entryName, const Type &defaultValue=Type(Zero)) const |
| Retrieve result. More... | |
| template<class Type > | |
| Type | getObjectResult (const word &objectName, const word &entryName, const Type &defaultValue=Type(Zero)) const |
| Retrieve result from named object. More... | |
| template<class Type > | |
| bool | getObjectResult (const word &objectName, const word &entryName, Type &value) const |
| Set result from named object, return true if set. More... | |
| word | resultType (const word &entryName) const |
| Retrieve the result type. More... | |
| word | objectResultType (const word &objectName, const word &entryName) const |
| Return the type of result. More... | |
| wordList | objectResultEntries () const |
| Retrieve the result entries. More... | |
| wordList | objectResultEntries (const word &objectName) const |
| Return result entries for named object. More... | |
| void | writeResultEntries (Ostream &os) const |
| Write the results entries for all objects to stream. More... | |
| void | writeResultEntries (const word &objectName, Ostream &os) const |
| Write the results entries for named object to stream. More... | |
| void | writeAllResultEntries (Ostream &os) const |
| Write the results entries for all objects to stream. More... | |
| Public Member Functions inherited from timeFunctionObject | |
| timeFunctionObject (const word &name, const Time &runTime) | |
| Construct from Time. More... | |
| virtual | ~timeFunctionObject ()=default |
| Destructor. More... | |
| const Time & | time () const |
| Return time database. More... | |
| objectRegistry & | storedObjects () |
| Write access to the output objects ("functionObjectObjects") registered on Time. More... | |
| const objectRegistry & | storedObjects () const |
| Const access to the output objects ("functionObjectObjects") registered on Time. More... | |
| Public Member Functions inherited from functionObject | |
| declareRunTimeSelectionTable (autoPtr, functionObject, dictionary,(const word &name, const Time &runTime, const dictionary &dict),(name, runTime, dict)) | |
| functionObject (const word &name, const bool withNamePrefix=defaultUseNamePrefix) | |
| Construct from components. More... | |
| autoPtr< functionObject > | clone () const |
| Return clone. More... | |
| virtual | ~functionObject ()=default |
| Destructor. More... | |
| virtual const word & | type () const =0 |
| Runtime type information. More... | |
| const word & | name () const noexcept |
| Return the name of this functionObject. More... | |
| bool | useNamePrefix () const noexcept |
| Return the flag for adding a scoping name prefix. More... | |
| bool | useNamePrefix (bool on) noexcept |
| Modify the flag for adding a scoping name prefix. More... | |
| virtual bool | execute (const label subIndex) |
| Execute using the specified subIndex. More... | |
| virtual bool | end () |
| Called when Time::run() determines that the time-loop exits. More... | |
| virtual bool | adjustTimeStep () |
| Called at the end of Time::adjustDeltaT() if adjustTime is true. More... | |
| virtual bool | filesModified () const |
| Did any file get changed during execution? More... | |
| virtual void | updateMesh (const mapPolyMesh &mpm) |
| Update for changes of mesh. More... | |
| virtual void | movePoints (const polyMesh &mesh) |
| Update for changes of mesh. More... | |
Additional Inherited Members | |
| Static Public Member Functions inherited from functionObject | |
| static autoPtr< functionObject > | New (const word &name, const Time &runTime, const dictionary &dict) |
| Select from dictionary, based on its "type" entry. More... | |
| Public Attributes inherited from functionObject | |
| bool | log |
| Flag to write log into Info. More... | |
| Static Public Attributes inherited from functionObject | |
| static int | debug |
| Flag to execute debug content. More... | |
| static bool | postProcess |
| Global post-processing mode switch. More... | |
| static bool | defaultUseNamePrefix |
| Global default for useNamePrefix. More... | |
| static word | outputPrefix |
| Directory prefix. More... | |
| Protected Member Functions inherited from fvMeshFunctionObject | |
| fvMeshFunctionObject (const fvMeshFunctionObject &)=delete | |
| No copy construct. More... | |
| void | operator= (const fvMeshFunctionObject &)=delete |
| No copy assignment. More... | |
| Protected Member Functions inherited from regionFunctionObject | |
| virtual const objectRegistry & | obr () const |
| The region or sub-region registry being used. More... | |
| template<class ObjectType > | |
| bool | foundObject (const word &fieldName) const |
| Find object (eg, a field) in the (sub) objectRegistry. More... | |
| template<class ObjectType > | |
| const ObjectType * | cfindObject (const word &fieldName) const |
| Return const pointer to the object (eg, a field) in the (sub) objectRegistry. More... | |
| template<class ObjectType > | |
| const ObjectType * | findObject (const word &fieldName) const |
| Return const pointer to the object (eg, a field) in the (sub) objectRegistry. More... | |
| template<class ObjectType > | |
| ObjectType * | findObject (const word &fieldName) |
| Return non-const pointer to the object of the given Type, (sub) objectRegistry. More... | |
| template<class ObjectType > | |
| ObjectType * | getObjectPtr (const word &fieldName) const |
| Return non-const pointer to the object of the given Type, using a const-cast to have it behave like a mutable. More... | |
| template<class ObjectType > | |
| const ObjectType & | lookupObject (const word &fieldName) const |
| Lookup and return object (eg, a field) from the (sub) objectRegistry. More... | |
| template<class ObjectType > | |
| ObjectType & | lookupObjectRef (const word &fieldName) const |
| Lookup and return object (eg, a field) from the (sub) objectRegistry. More... | |
| template<class ObjectType > | |
| bool | store (word &fieldName, const tmp< ObjectType > &tfield, bool cacheable=false) |
| Store the field in the (sub) objectRegistry under the given name. More... | |
| template<class ObjectType > | |
| bool | storeInDb (const word &fieldName, const tmp< ObjectType > &tfield, const objectRegistry &obr) |
| Store the field in an optional objectRegistry under the given name. More... | |
| bool | writeObject (const word &fieldName) |
| Write field if present in the (sub) objectRegistry. More... | |
| bool | clearObject (const word &fieldName) |
| Clear field from the (sub) objectRegistry if present. More... | |
| void | clearObjects (const wordList &objNames) |
| Clear fields from the (sub) objectRegistry if present. More... | |
| regionFunctionObject (const regionFunctionObject &)=delete | |
| No copy construct. More... | |
| void | operator= (const regionFunctionObject &)=delete |
| No copy assignment. More... | |
| Protected Member Functions inherited from stateFunctionObject | |
| const functionObjects::properties & | stateDict () const |
| Return a const reference to the state dictionary. More... | |
| functionObjects::properties & | stateDict () |
| Return non-const access to the state dictionary. More... | |
| stateFunctionObject (const stateFunctionObject &)=delete | |
| No copy construct. More... | |
| void | operator= (const stateFunctionObject &)=delete |
| No copy assignment. More... | |
| Protected Member Functions inherited from timeFunctionObject | |
| void | clearOutputObjects (const wordList &objNames) |
| Remove specified items from "functionObjectObjects". More... | |
| timeFunctionObject (const timeFunctionObject &)=delete | |
| No copy construct. More... | |
| void | operator= (const timeFunctionObject &)=delete |
| No copy assignment. More... | |
| Protected Member Functions inherited from functionObject | |
| word | scopedName (const word &name) const |
| Return a scoped (prefixed) name. More... | |
| Protected Attributes inherited from fvMeshFunctionObject | |
| const fvMesh & | mesh_ |
| Reference to the fvMesh. More... | |
| Protected Attributes inherited from regionFunctionObject | |
| word | subRegistryName_ |
| Name for alternative object registry. More... | |
| const objectRegistry & | obr_ |
| Reference to the region objectRegistry. More... | |
| const objectRegistry * | obrPtr_ |
| Pointer to alternative (eg, sub-region) objectRegistry. More... | |
| Protected Attributes inherited from timeFunctionObject | |
| const Time & | time_ |
| Reference to the time database. More... | |
Computes the steady-state equation of charge conservation to obtain the electric potential by strictly assuming a quasi-static electrostatic field for single-phase and multiphase applications.
The steady-state equation of the charge conservation:
![\[ \nabla \cdot \left( \sigma \nabla V \right) = 0 \]](form_333.png)
where
 | = | Electric potential [volt = kg m^2/(A s^3)] |
 | = | Isotropic conductivity of mixture [S/m = A^2 s^3/(kg m^3)] |
Optionally, electric field, current density and free-charge density fields can be written out by using the following equations:
![\[ \vec{E} = - \nabla V \]](form_334.png)
![\[ \vec{J} = \sigma \vec{E} = - \sigma \nabla V \]](form_335.png)
![\[ \rho_E = \nabla \cdot \left(\epsilon_m \vec{E} \right) = \nabla \cdot \left(\epsilon_0 \epsilon_r \vec{E} \right) \]](form_336.png)
where
 | = | Electric field [m kg/(s^3 A)] |
 | = | Current density [A/m^2] |
 | = | Volume charge density [C/m^3 = A s/m^3] |
 | = | Isotropic permittivity of mixture [F/m = A^2 s^4/(kg m^3)] |
 | = | Isotropic vacuum permittivity [F/m = A^2 s^4/(kg m^3)] |
 | = | Isotropic relative permittivity of mixture [-] |
For multiphase applications, sigma and epsilonr are blended (to consider their interface values) by using the simple weighted arithmetic mean interpolation, for example:
![\[ \sigma = \alpha_1 \sigma_1 + \alpha_2 \sigma_2 = \alpha_1 \sigma_1 + (1 - \alpha_1) \sigma_2 \]](form_343.png)
system/controlDict.functions: electricPotential1
{
// Mandatory entries
type electricPotential;
libs (solverFunctionObjects);
// Conditional entries
// Option-1: single-phase
sigma <scalar>;
epsilonr <scalar>;
// Option-2: multiphase
phases
{
alpha.air
{
sigma <scalar>;
epsilonr <scalar>;
}
alpha.water
{
sigma <scalar>;
epsilonr <scalar>;
}
alpha.mercury
{
sigma <scalar>;
epsilonr <scalar>;
}
...
}
// Optional entries
nCorr <int>;
writeDerivedFields <bool>;
V <word>;
electricField <bool>;
E <word>;
fvOptions <dict>;
// Inherited entries
...
}
where the entries mean:
| Property | Description | Type | Reqd | Deflt |
|---|---|---|---|---|
type | Type name: electricPotential | word | yes | - |
libs | Library name: solverFunctionObjects | word | yes | - |
sigma | Isotropic electrical conductivity of phase | scalar | yes | - |
epsilonr | Isotropic relative permittivity of phase | scalar | no | - |
nCorr | Number of corrector iterations | int | no | 1 |
writeDerivedFields | Flag to write extra fields | bool | no | false |
V | Name of electric potential field | word | no | electricPotential:V |
electricField | Flag to calculate electric field | bool | no | false |
E | Name of electric field | word | no | electricPotential:E |
fvOptions | List of finite-volume options | dict | no | - |
The inherited entries are elaborated in:
Fields written out when the writeDerivedFields entry is true:
| Operand | Type | Location |
|---|---|---|
Current density | volVectorField | <time>/electricPotential:J |
Charge density | volScalarField | <time>/electricPotential:rho |
Definition at line 290 of file electricPotential.H.
| electricPotential | ( | const word & | name, |
| const Time & | runTime, | ||
| const dictionary & | dict | ||
| ) |
Construct from Time and dictionary.
Definition at line 159 of file electricPotential.C.
References GeometricField< Type, PatchField, GeoMesh >::correctBoundaryConditions(), dict, Foam::fvc::grad(), IOobjectOption::NO_READ, IOobjectOption::NO_WRITE, and Foam::read().
|
virtualdefault |
Destructor.
| TypeName | ( | "electricPotential" | ) |
Runtime type information.
|
virtual |
Read the function object data.
Reimplemented from regionFunctionObject.
Definition at line 251 of file electricPotential.C.
References dict, Foam::dimCurrent, Foam::dimLength, Foam::dimless, Foam::dimMass, Foam::dimTime, Foam::endl(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, forAll, MinMax< scalar >::ge(), dictionary::getCheck(), Foam::glTF::key(), Log, Foam::name(), Foam::nl, phasei, Foam::pow3(), regionFunctionObject::read(), Foam::sqr(), and Foam::type().
|
virtual |
Calculate the function object.
Implements functionObject.
Definition at line 347 of file electricPotential.C.
References Foam::endl(), Foam::fvc::grad(), Foam::fvm::laplacian(), Log, Foam::name(), fvMatrix< Type >::relax(), sigma(), fvMatrix< Type >::solve(), and Foam::type().
|
virtual |
Write the function object output.
Implements functionObject.
Definition at line 382 of file electricPotential.C.
References fvPatchFieldBase::calculatedType(), Foam::fvc::div(), Foam::endl(), Foam::fvc::grad(), Log, Foam::name(), tmp< T >::New(), Foam::nl, IOobjectOption::NO_READ, IOobjectOption::NO_REGISTER, IOobjectOption::NO_WRITE, IOobject::scopedName(), sigma(), Foam::tab, Foam::type(), Ostream::write(), and regIOobject::write().
1.8.14