InterfaceQpValueUserObject

IMPORTANT NOTES * Any derived class of InterfaceUserObject does not support yet getMaterialProperty, please use auxvariables***

* This userobejct only support multiprocessing. Threading is not supported at this time *

Description !syntax description /UserObjects/InterfaceQpValueUserObject

InterfaceQpValueUserObject is a user object computing and storing average values across an interface for each quadrature. The kind of average value are the one available in InterfaceValueTools.

The stored value can be converted into an AuxVariable by using InterfaceValueUserObjectAux AuxKernel.

Example Input File Syntax

listing test/tests/userobjects/interface_user_object/interface_value_user_object_QP.i block=UserObjects/interface_value_uo

Test Interfae User Object computing and storing average values at each QP across an interface

Input Parameters

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
varThe variable name
C++ Type:std::vector
Options:
Description:The variable name

Required Parameters

execute_onTIMESTEP_ENDThe list of flag(s) indicating when this object should be executed, the available options include NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, FINAL, CUSTOM.
Default:TIMESTEP_END
C++ Type:ExecFlagEnum
Options:NONE INITIAL LINEAR NONLINEAR TIMESTEP_END TIMESTEP_BEGIN FINAL CUSTOM
Description:The list of flag(s) indicating when this object should be executed, the available options include NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, FINAL, CUSTOM.
interface_value_typeaverageType of scalar output
Default:average
C++ Type:MooseEnum
Options:average jump_master_minus_slave jump_slave_minus_master jump_abs master slave
Description:Type of scalar output
var_neighborThe variable name
C++ Type:std::vector
Options:
Description:The variable name

Optional Parameters

allow_duplicate_execution_on_initialFalseIn the case where this UserObject is depended upon by an initial condition, allow it to be executed twice during the initial setup (once before the IC and again after mesh adaptivity (if applicable).
Default:False
C++ Type:bool
Options:
Description:In the case where this UserObject is depended upon by an initial condition, allow it to be executed twice during the initial setup (once before the IC and again after mesh adaptivity (if applicable).
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.
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

Input Files

test/tests/userobjects/interface_user_object/interface_value_user_object_QP.i

test/tests/userobjects/interface_user_object/interface_value_user_object_QP.i

[Mesh]
  [gen]
    type = GeneratedMeshGenerator
    dim = 2
    nx = 2
    xmax = 2
    ny = 2
    ymax = 2
    elem_type = QUAD4
  []
  [./subdomain_id]
    input = gen
    type = SubdomainBoundingBoxGenerator
    bottom_left = '0 0 0'
    top_right = '1 1 0'
    block_id = 1
  [../]

  [./interface]
    type = SideSetsBetweenSubdomainsGenerator
    input = subdomain_id
    master_block = '0'
    paired_block = '1'
    new_boundary = 'interface'
  [../]

[]

[Functions]
  [./fn_exact]
    type = ParsedFunction
    value = 'x*x+y*y'
  [../]

  [./ffn]
    type = ParsedFunction
    value = -4
  [../]
[]

[UserObjects]
  [./interface_value_uo]
    type = InterfaceQpValueUserObject
    var = diffusivity_1
    var_neighbor = diffusivity_2
    boundary = 'interface'
    execute_on = 'initial timestep_end'
    interface_value_type = average
  [../]
  [./interface_master_minus_slave_uo]
    type = InterfaceQpValueUserObject
    var = diffusivity_1
    var_neighbor = diffusivity_2
    boundary = 'interface'
    execute_on = 'initial timestep_end'
    interface_value_type = jump_master_minus_slave
  [../]
  [./interface_slave_minus_master_uo]
    type = InterfaceQpValueUserObject
    var = diffusivity_1
    var_neighbor = diffusivity_2
    boundary = 'interface'
    execute_on = 'initial timestep_end'
    interface_value_type = jump_slave_minus_master
  [../]
  [./interface_absolute_jump_uo]
    type = InterfaceQpValueUserObject
    var = diffusivity_1
    var_neighbor = diffusivity_2
    boundary = 'interface'
    execute_on = 'initial timestep_end'
    interface_value_type = jump_abs
  [../]
  [./interface_master_uo]
    type = InterfaceQpValueUserObject
    var = diffusivity_1
    var_neighbor = diffusivity_2
    boundary = 'interface'
    execute_on = 'initial timestep_end'
    interface_value_type = master
  [../]
  [./interface_slave_uo]
    type = InterfaceQpValueUserObject
    var = diffusivity_1
    var_neighbor = diffusivity_2
    boundary = 'interface'
    execute_on = 'initial timestep_end'
    interface_value_type = slave
  [../]
[]

[Variables]
  [./u]
    family = LAGRANGE
    order = FIRST
  [../]
[]


[Kernels]
  [./diff]
    type = Diffusion
    variable = u
  [../]

  [./ffn]
    type = BodyForce
    variable = u
    function = ffn
  [../]
[]

[BCs]
  [./all]
    type = FunctionDirichletBC
    variable = u
    boundary = '0 1 2 3'
    function = fn_exact
  [../]
[]

[Materials]
  [./stateful1]
    type = StatefulMaterial
    block = 0
    initial_diffusivity = 5
    # outputs = all
  [../]
  [./stateful2]
    type = StatefulMaterial
    block = 1
    initial_diffusivity = 2
    # outputs = all
  [../]
[]

[AuxKernels]
  [./diffusivity_1]
    type = MaterialRealAux
    property = diffusivity
    variable = diffusivity_1
  []
  [./diffusivity_2]
    type = MaterialRealAux
    property = diffusivity
    variable = diffusivity_2
  []
  [./interface_avg_qp_aux]
    type = InterfaceValueUserObjectAux
    variable = avg_qp
    boundary = 'interface'
    interface_uo_name = interface_value_uo
  []
  [./interface_master_minus_slave_qp_aux]
    type = InterfaceValueUserObjectAux
    variable = master_minus_slave_qp
    boundary = 'interface'
    interface_uo_name = interface_master_minus_slave_uo
  [../]
  [./interface_slave_minus_master_qp_aux]
    type = InterfaceValueUserObjectAux
    variable = slave_minus_master_qp
    boundary = 'interface'
    interface_uo_name = interface_slave_minus_master_uo
  [../]
  [./interface_absolute_jump_qp_aux]
    type = InterfaceValueUserObjectAux
    variable = abs_jump_qp
    boundary = 'interface'
    interface_uo_name = interface_absolute_jump_uo
  [../]
  [./interface_master_qp_aux]
    type = InterfaceValueUserObjectAux
    variable = master_qp
    boundary = 'interface'
    interface_uo_name = interface_master_uo
  [../]
  [./interface_slave_qp_aux]
    type = InterfaceValueUserObjectAux
    variable = slave_qp
    boundary = 'interface'
    interface_uo_name = interface_slave_uo
  [../]


[]

[AuxVariables]
  [./diffusivity_1]
    family = MONOMIAL
    order = CONSTANT
  []
  [./diffusivity_2]
    family = MONOMIAL
    order = CONSTANT
  []
  [./avg_qp]
    family = MONOMIAL
    order = CONSTANT
  []
  [./master_minus_slave_qp]
    family = MONOMIAL
    order = CONSTANT
  []
  [./slave_minus_master_qp]
    family = MONOMIAL
    order = CONSTANT
  []
  [./abs_jump_qp]
    family = MONOMIAL
    order = CONSTANT
  []
  [./master_qp]
    family = MONOMIAL
    order = CONSTANT
  []
  [./slave_qp]
    family = MONOMIAL
    order = CONSTANT
  []
[]



[Postprocessors]
  [./interface_average_PP]
    type = SideAverageValue
    boundary = interface
    variable =  avg_qp
  [../]
  [./master_minus_slave_qp_PP]
    type = SideAverageValue
    boundary = interface
    variable =  master_minus_slave_qp
  [../]
  [./slave_minus_master_qp_PP]
    type = SideAverageValue
    boundary = interface
    variable =  slave_minus_master_qp
  [../]
  [./abs_jump_qp_PP]
    type = SideAverageValue
    boundary = interface
    variable =  abs_jump_qp
  [../]
  [./master_qp_PP]
    type = SideAverageValue
    boundary = interface
    variable =  master_qp
  [../]
  [./slave_qp_PP]
    type = SideAverageValue
    boundary = interface
    variable =  slave_qp
  [../]
[]

[Executioner]
  type = Steady
  solve_type = NEWTON
[]

[Outputs]
  exodus = true
[]

IMPORTANT NOTES * Any derived class of InterfaceUserObject does not support yet getMaterialProperty , please use auxvariables ***
Description ! syntax description / UserObjects / InterfaceQpValueUserObject
Example Input File Syntax
Input Parameters
Input Files

Application Usage

Physics and Syntax

Application Development

Framework Development

MOOSEDocs

Infrastructure

Questions

Information and Tools