FunctionPresetBC

The same as FunctionDirichletBC except the value is applied before the solve begins

Description

The FunctionPresetBC takes the same inputs as FunctionDirichletBC and also acts as a Dirichlet boundary condition. However, the implementation is slightly different. FunctionPresetBC causes the value of the boundary condition to be applied before the solve begins where FunctionDirichletBC enforces the boundary condition as the solve progresses. In certain situations, one is better than another.

Example Input Syntax


[BCs]
  active = 'left right'

  [./left]
    type = FunctionPresetBC
    variable = u
    boundary = 3
    function = left
  [../]

  [./right]
    type = FunctionPresetBC
    variable = u
    boundary = 1
    function = right
  [../]
[]
(test/tests/bcs/bc_preset_nodal/bc_function_preset.i)

Input Parameters

  • functionThe forcing function.

    C++ Type:FunctionName

    Options:

    Description:The forcing function.

  • variableThe name of the variable that this boundary condition applies to

    C++ Type:NonlinearVariableName

    Options:

    Description:The name of the variable that this boundary condition applies to

  • boundaryThe list of boundary IDs from the mesh where this boundary condition applies

    C++ Type:std::vector

    Options:

    Description:The list of boundary IDs from the mesh where this boundary condition applies

Required Parameters

  • save_inThe name of auxiliary variables to save this BC's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

    C++ Type:std::vector

    Options:

    Description:The name of auxiliary variables to save this BC's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

  • diag_save_inThe name of auxiliary variables to save this BC's diagonal jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

    C++ Type:std::vector

    Options:

    Description:The name of auxiliary variables to save this BC's diagonal jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)

Optional Parameters

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

    C++ Type:std::vector

    Options:

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

  • enableTrueSet the enabled status of the MooseObject.

    Default:True

    C++ Type:bool

    Options:

    Description:Set the enabled status of the MooseObject.

  • seed0The seed for the master random number generator

    Default:0

    C++ Type:unsigned int

    Options:

    Description:The seed for the master random number generator

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

    Default:True

    C++ Type:bool

    Options:

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

  • 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

    Options:

    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

  • vector_tagsresidualThe tag for the vectors this Kernel should fill

    Default:residual

    C++ Type:MultiMooseEnum

    Options:nontime time residual

    Description:The tag for the vectors this Kernel should fill

  • extra_vector_tagsThe extra tags for the vectors this Kernel should fill

    C++ Type:std::vector

    Options:

    Description:The extra tags for the vectors this Kernel should fill

  • matrix_tagssystem timeThe tag for the matrices this Kernel should fill

    Default:system time

    C++ Type:MultiMooseEnum

    Options:nontime system time

    Description:The tag for the matrices this Kernel should fill

  • extra_matrix_tagsThe extra tags for the matrices this Kernel should fill

    C++ Type:std::vector

    Options:

    Description:The extra tags for the matrices this Kernel should fill

Tagging Parameters

Input Files