LineSegmentCutUserObject

Creates a UserObject for a line segment cut on 2D meshes for XFEM

Overview

The LineSegmentCutUserObject defines a line segment cut for XFEM to make on a 2 dimensional mesh. The start and end points of the line segment are defined in cut_data as a vector of four Real values: start point x, start point y, end point x, end point y. By default, the entire cut specified is performed at $var element = document.getElementById("moose-equation-d16df98a-1caf-4246-aa34-d9ed6d834120");katex.render("t=0", element, {displayMode:false,throwOnError:false});$ . Propagation of the cut may be prescribed along the line segment by specifying the time_start_cut and time_end_cut parameters in simulation time. The cut will lengthen by $var element = document.getElementById("moose-equation-1203d2f6-1037-4b6a-8415-d5f48cb6b10c");katex.render("r_{total} \\cdot \\frac{t_{current} - t_{start}}{t_{end} - t_{start}}", element, {displayMode:false,throwOnError:false});$ at each timestep from time_start_cut until time_end_cut. There are also options to scale and translate the points given in cut data. The scale and translation of the x and y coordinates must be specified separately, and if specified, the scale and translation are applied to both start and end points.

Example Input Syntax

[UserObjects<<<{"href": "../../syntax/UserObjects/index.html"}>>>]
  [./line_seg_cut_uo]
    type = LineSegmentCutUserObject<<<{"description": "Creates a UserObject for a line segment cut on 2D meshes for XFEM", "href": "LineSegmentCutUserObject.html"}>>>
    cut_data<<<{"description": "Vector of Real values providing cut information"}>>> = '0.35 1.0 0.35 0.2'
    time_start_cut<<<{"description": "Start time of geometric cut propagation"}>>> = 0.0
    time_end_cut<<<{"description": "End time of geometric cut propagation"}>>> = 2.0
  [../]
[]

Input Parameters

cut_dataVector of Real values providing cut information
C++ Type:std::vector<double>
Unit:(no unit assumed)
Controllable:No
Description:Vector of Real values providing cut information

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
cut_scaleX,Y scale factors for geometric cuts
C++ Type:std::vector<double>
Unit:(no unit assumed)
Controllable:No
Description:X,Y scale factors for geometric cuts
cut_translateX,Y translations for geometric cuts
C++ Type:std::vector<double>
Unit:(no unit assumed)
Controllable:No
Description:X,Y translations for geometric cuts
heal_alwaysFalseHeal previous cuts at every time step
Default:False
C++ Type:bool
Controllable:No
Description:Heal previous cuts at every time step
time_end_cut0End time of geometric cut propagation
Default:0
C++ Type:double
Unit:(no unit assumed)
Controllable:No
Description:End time of geometric cut propagation
time_start_cut0Start time of geometric cut propagation
Default:0
C++ Type:double
Unit:(no unit assumed)
Controllable:No
Description:Start time of geometric cut propagation

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
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).
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
Options:XFEM_MARK, NONE, INITIAL, LINEAR, LINEAR_CONVERGENCE, NONLINEAR, NONLINEAR_CONVERGENCE, POSTCHECK, TIMESTEP_END, TIMESTEP_BEGIN, MULTIAPP_FIXED_POINT_END, MULTIAPP_FIXED_POINT_BEGIN, MULTIAPP_FIXED_POINT_CONVERGENCE, 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.
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
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
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
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
Controllable:No
Description:Forces the UserObject to be executed in PREIC during initial setup

Execution Scheduling 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

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
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.

Material Property Retrieval Parameters

(moose/modules/xfem/test/tests/high_order_elements/diffusion_2d.i)

[GlobalParams]
  order = SECOND
  family = LAGRANGE
[]

[Mesh]
  type = GeneratedMesh
  dim = 2
  nx = 3
  ny = 4
  xmin = 0.0
  xmax = 1.0
  ymin = 0.0
  ymax = 1.0
  elem_type = TRI6
[]

[XFEM]
  qrule = volfrac
  output_cut_plane = true
[]

[UserObjects]
  [./line_seg_cut_uo]
    type = LineSegmentCutUserObject
    cut_data = '0.35 1.0 0.35 0.2'
    time_start_cut = 0.0
    time_end_cut = 2.0
  [../]
[]

[Variables]
  [./u]
  [../]
[]

[Functions]
  [./u_left]
    type = PiecewiseLinear
    x = '0   2'
    y = '0  0.1'
  [../]
[]

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

[BCs]
# Define boundary conditions
  [./left_u]
    type = FunctionDirichletBC
    variable = u
    boundary = 3
    function = u_left
  [../]

  [./right_u]
    type = DirichletBC
    variable = u
    boundary = 1
    value = 0
  [../]
[]

[Executioner]
  type = Transient
  solve_type = 'PJFNK'
  petsc_options_iname = '-pc_type -pc_hypre_type'
  petsc_options_value = 'hypre boomeramg'
  line_search = 'none'

  l_tol = 1e-3
  nl_max_its = 15
  nl_rel_tol = 1e-10
  nl_abs_tol = 1e-10

  start_time = 0.0
  dt = 1.0
  end_time = 2.0
[]

[Outputs]
  time_step_interval = 1
  execute_on = timestep_end
  exodus = true
  [./console]
    type = Console
    output_linear = true
  [../]
[]

Overview
Example Input Syntax
Input Parameters

Usage

Development

Demonstration