ComboCutUserObject

Combine multiple geometric cut userobjects.

Overview

The ComboCutUserObject combines multiple GeometricCutUserObjects to create a composite cut. Currently, all GeometricCutUserObjects are assumed to be non-overlapping, i.e. each element can only be cut by one geometric cut.

Each GeometricCutUserObject may have defined its own set of CutSubdomainIDs, and the ComboCutUserObject follows the key-value dictionary provided by the user to assign a CutSubdomainID to each of the cut subdomains.

Example Input File Syntax

Input Parameters

cut_subdomain_combinationsPossible combinations of the cut subdomain IDs. The sequence of each combination should follow the sequence provided in the geometric_cut_userobjects parameter. Use semicolons to separate different combinations.
C++ Type:std::vector<std::vector<unsigned int>>
Unit:(no unit assumed)
Controllable:No
Description:Possible combinations of the cut subdomain IDs. The sequence of each combination should follow the sequence provided in the geometric_cut_userobjects parameter. Use semicolons to separate different combinations.
cut_subdomainsResulting combined cut subdomain IDs for each of the combination.
C++ Type:std::vector<unsigned int>
Unit:(no unit assumed)
Controllable:No
Description:Resulting combined cut subdomain IDs for each of the combination.
geometric_cut_userobjectsVector of geometric cut userobjects to combine
C++ Type:std::vector<UserObjectName>
Unit:(no unit assumed)
Controllable:No
Description:Vector of geometric cut userobjects to combine

Required Parameters

blockThe list of blocks (ids or names) that this object will be applied
C++ Type:std::vector<SubdomainName>
Unit:(no unit assumed)
Controllable:No
Description:The list of blocks (ids or names) that this object will be applied
execute_onXFEM_MARKThe list of flag(s) indicating when this object should be executed. For a description of each flag, see https://mooseframework.inl.gov/source/interfaces/SetupInterface.html.
Default:XFEM_MARK
C++ Type:ExecFlagEnum
Unit:(no unit assumed)
Options:XFEM_MARK, FORWARD, ADJOINT, HOMOGENEOUS_FORWARD, ADJOINT_TIMESTEP_BEGIN, ADJOINT_TIMESTEP_END, NONE, INITIAL, LINEAR, NONLINEAR_CONVERGENCE, NONLINEAR, POSTCHECK, TIMESTEP_END, TIMESTEP_BEGIN, MULTIAPP_FIXED_POINT_END, MULTIAPP_FIXED_POINT_BEGIN, FINAL, CUSTOM
Controllable:No
Description:The list of flag(s) indicating when this object should be executed. For a description of each flag, see https://mooseframework.inl.gov/source/interfaces/SetupInterface.html.
heal_alwaysFalseHeal previous cuts at every time step
Default:False
C++ Type:bool
Unit:(no unit assumed)
Controllable:No
Description:Heal previous cuts at every time step
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
Unit:(no unit assumed)
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.
use_interpolated_stateFalseFor the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.
Default:False
C++ Type:bool
Unit:(no unit assumed)
Controllable:No
Description:For the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

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
Unit:(no unit assumed)
Controllable:No
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<std::string>
Unit:(no unit assumed)
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
Unit:(no unit assumed)
Controllable:Yes
Description:Set the enabled status of the MooseObject.
execution_order_group0Execution order groups are executed in increasing order (e.g., the lowest number is executed first). Note that negative group numbers may be used to execute groups before the default (0) group. Please refer to the user object documentation for ordering of user object execution within a group.
Default:0
C++ Type:int
Unit:(no unit assumed)
Controllable:No
Description:Execution order groups are executed in increasing order (e.g., the lowest number is executed first). Note that negative group numbers may be used to execute groups before the default (0) group. Please refer to the user object documentation for ordering of user object execution within a group.
force_postauxFalseForces the UserObject to be executed in POSTAUX
Default:False
C++ Type:bool
Unit:(no unit assumed)
Controllable:No
Description:Forces the UserObject to be executed in POSTAUX
force_preauxFalseForces the UserObject to be executed in PREAUX
Default:False
C++ Type:bool
Unit:(no unit assumed)
Controllable:No
Description:Forces the UserObject to be executed in PREAUX
force_preicFalseForces the UserObject to be executed in PREIC during initial setup
Default:False
C++ Type:bool
Unit:(no unit assumed)
Controllable:No
Description:Forces the UserObject to be executed in PREIC during initial setup
implicitTrueDetermines whether this object is calculated using an implicit or explicit form
Default:True
C++ Type:bool
Unit:(no unit assumed)
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
Unit:(no unit assumed)
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
Unit:(no unit assumed)
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

Input Files

(modules/xfem/test/tests/switching_material/two_cuts_stationary.i)
(modules/xfem/test/tests/switching_material/two_cuts_moving.i)

(modules/xfem/test/tests/switching_material/two_cuts_stationary.i)

[Problem]
  solve = false
[]

[XFEM]
  qrule = volfrac
  output_cut_plane = true
[]

[UserObjects]
  [cut1]
    type = LevelSetCutUserObject
    level_set_var = phi1
    negative_id = 1
    positive_id = 33
    execute_on = NONE
  []
  [cut2]
    type = LevelSetCutUserObject
    level_set_var = phi2
    negative_id = 5
    positive_id = 16
    execute_on = NONE
  []
  [combo]
    type = ComboCutUserObject
    geometric_cut_userobjects = 'cut1 cut2'
    cut_subdomain_combinations = '1 5;
                                  1 16;
                                  33 5;
                                  33 16'
    cut_subdomains = '1 3 5 7'
  []
[]

[Mesh]
  [square]
    type = GeneratedMeshGenerator
    dim = 2
    nx = 5
    ny = 5
  []
[]

[AuxVariables]
  [phi1]
    [InitialCondition]
      type = FunctionIC
      function = 'x-0.213'
    []
  []
  [phi2]
    [InitialCondition]
      type = FunctionIC
      function = 'x-0.728'
    []
  []
  [cut1_id]
    order = CONSTANT
    family = MONOMIAL
  []
  [cut2_id]
    order = CONSTANT
    family = MONOMIAL
  []
  [combo_id]
    order = CONSTANT
    family = MONOMIAL
  []
[]

[AuxKernels]
  [cut1_id]
    type = CutSubdomainIDAux
    variable = cut1_id
    cut = cut1
  []
  [cut2_id]
    type = CutSubdomainIDAux
    variable = cut2_id
    cut = cut2
  []
  [combo_id]
    type = CutSubdomainIDAux
    variable = combo_id
    cut = combo
  []
[]

[Materials]
  [diffusivity_A]
    type = GenericConstantMaterial
    prop_names = 'A_D'
    prop_values = '5'
  []
  [diffusivity_B]
    type = GenericConstantMaterial
    prop_names = 'B_D'
    prop_values = '0.5'
  []
  [diffusivity_C]
    type = GenericConstantMaterial
    prop_names = 'C_D'
    prop_values = '12'
  []
  [diffusivity_D]
    type = GenericConstantMaterial
    prop_names = 'D_D'
    prop_values = '9'
  []
  [diff_combined]
    type = XFEMCutSwitchingMaterialReal
    cut_subdomain_ids = '1 3 5 7'
    base_names = 'A B C D'
    prop_name = D
    geometric_cut_userobject = combo
    outputs = 'exodus'
    output_properties = 'D'
  []
[]

[Executioner]
  type = Transient

  num_steps = 1

  max_xfem_update = 1
[]

[Outputs]
  exodus = true
[]

(modules/xfem/test/tests/switching_material/two_cuts_moving.i)

[Problem]
  solve = false
[]

[XFEM]
  qrule = volfrac
  output_cut_plane = true
[]

[UserObjects]
  [cut1]
    type = LevelSetCutUserObject
    level_set_var = phi1
    negative_id = 1
    positive_id = 33
    execute_on = NONE
  []
  [cut2]
    type = LevelSetCutUserObject
    level_set_var = phi2
    negative_id = 5
    positive_id = 16
    execute_on = NONE
  []
  [combo]
    type = ComboCutUserObject
    geometric_cut_userobjects = 'cut1 cut2'
    cut_subdomain_combinations = '1 5;
                                  1 16;
                                  33 5;
                                  33 16'
    cut_subdomains = '1 3 5 7'
    heal_always = true
  []
[]

[Mesh]
  [square]
    type = GeneratedMeshGenerator
    dim = 2
    nx = 5
    ny = 5
  []
[]

[AuxVariables]
  [phi1]
  []
  [phi2]
  []
  [cut1_id]
    order = CONSTANT
    family = MONOMIAL
  []
  [cut2_id]
    order = CONSTANT
    family = MONOMIAL
  []
  [combo_id]
    order = CONSTANT
    family = MONOMIAL
  []
[]

[AuxKernels]
  [phi1]
    type = FunctionAux
    variable = phi1
    function = 'x-0.213-t'
    execute_on = 'INITIAL TIMESTEP_BEGIN'
  []
  [phi2]
    type = FunctionAux
    variable = phi2
    function = 'x-0.728+t'
    execute_on = 'INITIAL TIMESTEP_BEGIN'
  []
  [cut1_id]
    type = CutSubdomainIDAux
    variable = cut1_id
    cut = cut1
  []
  [cut2_id]
    type = CutSubdomainIDAux
    variable = cut2_id
    cut = cut2
  []
  [combo_id]
    type = CutSubdomainIDAux
    variable = combo_id
    cut = combo
  []
[]

[Materials]
  [diffusivity_A]
    type = GenericConstantMaterial
    prop_names = 'A_D'
    prop_values = '5'
  []
  [diffusivity_B]
    type = GenericConstantMaterial
    prop_names = 'B_D'
    prop_values = '0.5'
  []
  [diffusivity_C]
    type = GenericConstantMaterial
    prop_names = 'C_D'
    prop_values = '12'
  []
  [diffusivity_D]
    type = GenericConstantMaterial
    prop_names = 'D_D'
    prop_values = '9'
  []
  [diff_combined]
    type = XFEMCutSwitchingMaterialReal
    cut_subdomain_ids = '1 3 5 7'
    base_names = 'A B C D'
    prop_name = D
    geometric_cut_userobject = combo
    outputs = 'exodus'
    output_properties = 'D'
  []
[]

[Executioner]
  type = Transient

  dt = 0.05
  num_steps = 2

  max_xfem_update = 1
[]

[Outputs]
  exodus = true
[]

Overview
Example Input File Syntax
Input Parameters
Input Files