ChargeTransferReaction

buildconstruction:Undocumented Class

The ChargeTransferReaction has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

The Butler-Volmer condition for current density across the electrode/electrolyte interface.

Overview

Example Input File Syntax

Input Parameters

  • charge_transfer_coefficientThe dimensionless charge transfer coefficient

    C++ Type:double

    Controllable:No

    Description:The dimensionless charge transfer coefficient

  • charge_transfer_current_densityGive the current density a name

    C++ Type:MaterialPropertyName

    Controllable:No

    Description:Give the current density a name

  • charge_transfer_heat_fluxGive the heat flux a name

    C++ Type:MaterialPropertyName

    Controllable:No

    Description:Give the heat flux a name

  • charge_transfer_mass_fluxGive the mass flux a name

    C++ Type:MaterialPropertyName

    Controllable:No

    Description:Give the mass flux a name

  • electric_potentialElectric potential

    C++ Type:std::vector<VariableName>

    Controllable:No

    Description:Electric potential

  • exchange_current_densityThe exchange current density (normal to the interface) for the electrode/electrolyte interface

    C++ Type:double

    Controllable:No

    Description:The exchange current density (normal to the interface) for the electrode/electrolyte interface

  • faraday_constantThe Faraday's constant

    C++ Type:double

    Controllable:No

    Description:The Faraday's constant

  • ideal_gas_constantThe ideal gas constant

    C++ Type:double

    Controllable:No

    Description:The ideal gas constant

  • neighbor_electric_potentialNeighbor electric potential

    C++ Type:std::vector<VariableName>

    Controllable:No

    Description:Neighbor electric potential

  • open_circuit_potentialThe open-circuit potential

    C++ Type:MaterialPropertyName

    Controllable:No

    Description:The open-circuit potential

  • temperatureThe temperature

    C++ Type:std::vector<VariableName>

    Controllable:No

    Description:The temperature

Required Parameters

  • blockThe list of blocks (ids or names) that this object will be applied

    C++ Type:std::vector<SubdomainName>

    Controllable:No

    Description:The list of blocks (ids or names) that this object will be applied

  • boundaryThe list of boundaries (ids or names) from the mesh where this object applies

    C++ Type:std::vector<BoundaryName>

    Controllable:No

    Description:The list of boundaries (ids or names) from the mesh where this object applies

  • computeTrueWhen false, MOOSE will not call compute methods on this material. The user must call computeProperties() after retrieving the MaterialBase via MaterialBasePropertyInterface::getMaterialBase(). Non-computed MaterialBases are not sorted for dependencies.

    Default:True

    C++ Type:bool

    Controllable:No

    Description:When false, MOOSE will not call compute methods on this material. The user must call computeProperties() after retrieving the MaterialBase via MaterialBasePropertyInterface::getMaterialBase(). Non-computed MaterialBases are not sorted for dependencies.

  • declare_suffixAn optional suffix parameter that can be appended to any declared properties. The suffix will be prepended with a '_' character.

    C++ Type:MaterialPropertyName

    Controllable:No

    Description:An optional suffix parameter that can be appended to any declared properties. The suffix will be prepended with a '_' character.

  • degradationInterface degradation

    C++ Type:MaterialPropertyName

    Controllable:No

    Description:Interface degradation

  • interface_resistanceInterface resistance. The resistance is assumed to be independent of the transfer current, for now.

    C++ Type:MaterialPropertyName

    Controllable:No

    Description:Interface resistance. The resistance is assumed to be independent of the transfer current, for now.

  • prop_getter_suffixAn optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

    C++ Type:MaterialPropertyName

    Controllable:No

    Description:An optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

Optional Parameters

  • control_tagsAdds user-defined labels for accessing object parameters via control logic.

    C++ Type:std::vector<std::string>

    Controllable:No

    Description:Adds user-defined labels for accessing object parameters via control logic.

  • enableTrueSet the enabled status of the MooseObject.

    Default:True

    C++ Type:bool

    Controllable:Yes

    Description:Set the enabled status of the MooseObject.

  • implicitTrueDetermines whether this object is calculated using an implicit or explicit form

    Default:True

    C++ Type:bool

    Controllable:No

    Description:Determines whether this object is calculated using an implicit or explicit form

  • seed0The seed for the master random number generator

    Default:0

    C++ Type:unsigned int

    Controllable:No

    Description:The seed for the master random number generator

  • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

    Default:False

    C++ Type:bool

    Controllable:No

    Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

Advanced Parameters

  • output_propertiesList of material properties, from this material, to output (outputs must also be defined to an output type)

    C++ Type:std::vector<std::string>

    Controllable:No

    Description:List of material properties, from this material, to output (outputs must also be defined to an output type)

  • outputsnone Vector of output names where you would like to restrict the output of variables(s) associated with this object

    Default:none

    C++ Type:std::vector<OutputName>

    Controllable:No

    Description:Vector of output names where you would like to restrict the output of variables(s) associated with this object

Outputs Parameters

Input Files