TimedSubdomainModifier

Modify element subdomain ID of entire subdomains for given points in time. This mesh modifier only runs on the undisplaced mesh, and it will modify both the undisplaced and the displaced mesh.

Overview

For geometrically complex models, an efficient option is to define the volumes to be excavated/backfilled by means of subdomains (aka 'blocks'). This leads to the task of moving all elements from one subdomain to another at pre-known points in time. Furthermore, in some engineering applications (e.g. geotechnics or mining) it might be necessary to reassign several subdomains during one simulation. Addressing this task, the TimedSubdomainModifier eases re-assignment of all elements of a subdomain, makes Moose input files shorter, and reduces potential sources of error compared to the usage of CoupledVarThresholdElementSubdomainModifier (which in turn has its advantages if the geometry is not organized into subdomains).

The TimedSubdomainModifier inherits from the ElementSubdomainModifier. Details on solution reinitialization, stateful material property reinitialization and moving boundary/interface nodeset/sideset modification can be found in the description of the ElementSubdomainModifier.

The subdomains and times to be used by the TimedSubdomainModifier can be specified using one of the following options:

3 vectors containing the times, source and destination subdomains/blocks, or
path to an CSV file

Example Input File Syntax

Vectors of data in the input file

If the data on the subdomains and times should be provided directly in the input file, the following 3 parameters must be used. The vector of data in each parameter must have the same number of items:

"times": Vector of times at which the elements are to be moved.
"blocks_from": Vector of subdomain/blocks to move from. The subdomains/blocks may be given as ID or name.
"blocks_to": Vector of subdomain/blocks to move to. The subdomains/blocks may be given as ID or name.

[MeshModifiers]
  [GlobalSubdomainModifier]
    type = TimedSubdomainModifier
    times = '      0.4            0.6  0.4'
    blocks_from = '2              4    3'
    blocks_to = '  Box2_inactive  2    Box3_inactive' # Subdomain names are permitted ('Box2_inactive' = 4, etc)
    execute_on = 'INITIAL TIMESTEP_BEGIN'
  []
[]

Reading data from CSV file

To read the data on the subdomains and times from an CSV file, the following parameters are to be used:

"data_file": Name of the file in which the data is read.
"delimiter": Optional CSV delimiter character. Defaults to comma (,).
"comment": Optional CSV comment character. Defaults to hash character (;).
"header": This parameter must be set to True, if the columns are to be found via header ("time_column_text", "blocks_from_column_text", and "blocks_to_column_text"). See following parameters.
"time_column_index" -or- "time_column_text": Zero-based index or name of the column defining the times.
"blocks_from_column_index" -or- "blocks_from_column_text": Zero-based index or name of the column defining the subdomains/blocks to move all elements from.
"blocks_to_column_index" -or- "blocks_to_column_text": Zero-based index or name of the column defining the subdomains/blocks to move all elements to.

[MeshModifiers]
  [GlobalSubdomainModifier]
    type = TimedSubdomainModifier
    header = ON
    data_file = 'tsm.csv'
    comment = '#'
    execute_on = 'INITIAL TIMESTEP_BEGIN'
  []
[]

With the corresponding CSV-file:

time,  block_from,  block_to
0.4,   2,           Box2_inactive   # Subdomain names are permitted 'Box2_inactive' == 3 (as well as comments!)
0.6,   3,           2

Input 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_onTIMESTEP_ENDThe 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:TIMESTEP_END
C++ Type:ExecFlagEnum
Unit:(no unit assumed)
Options: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.
moving_boundariesMoving boundaries between subdomains. These boundaries (both sidesets and nodesets) will be updated for elements that change subdomain. The subdomains that each moving boundary lies between shall be specified using the parameter 'moving_boundary_subdomain_pairs'. If one boundary and multiple subdomain pairs are specified, then it is assumed that the pairs all apply to the boundary. A boundary will be created on the mesh if it does not already exist.
C++ Type:std::vector<BoundaryName>
Unit:(no unit assumed)
Controllable:No
Description:Moving boundaries between subdomains. These boundaries (both sidesets and nodesets) will be updated for elements that change subdomain. The subdomains that each moving boundary lies between shall be specified using the parameter 'moving_boundary_subdomain_pairs'. If one boundary and multiple subdomain pairs are specified, then it is assumed that the pairs all apply to the boundary. A boundary will be created on the mesh if it does not already exist.
moving_boundary_subdomain_pairsThe subdomain pairs associated with each moving boundary. For each pair of subdomains, only the element side from the first subdomain will be added to the moving boundary, i.e., the side normal is pointing from the first subdomain to the second subdomain. The pairs shall be delimited by ';'. If a pair only has one subdomain, the moving boundary is associated with the subdomain's external boundary, i.e., when the elements have no neighboring elements.
C++ Type:std::vector<std::vector<SubdomainName>>
Unit:(no unit assumed)
Controllable:No
Description:The subdomain pairs associated with each moving boundary. For each pair of subdomains, only the element side from the first subdomain will be added to the moving boundary, i.e., the side normal is pointing from the first subdomain to the second subdomain. The pairs shall be delimited by ';'. If a pair only has one subdomain, the moving boundary is associated with the subdomain's external boundary, i.e., when the elements have no neighboring elements.
old_subdomain_reinitializedTrueThis parameter must be set with a non-empty list in 'reinitialize_subdomains'. When set to the default true, the element's old subdomain is not considered when determining if an element should be reinitialized. If set to false, only elements whose old subdomain was not in 'reinitialize_subdomains' are reinitialized.
Default:True
C++ Type:bool
Unit:(no unit assumed)
Controllable:No
Description:This parameter must be set with a non-empty list in 'reinitialize_subdomains'. When set to the default true, the element's old subdomain is not considered when determining if an element should be reinitialized. If set to false, only elements whose old subdomain was not in 'reinitialize_subdomains' are reinitialized.
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.
reinitialize_subdomainsANY_BLOCK_ID By default, any element which changes subdomain is reinitialized. If a list of subdomains (IDs or names) is provided, then only elements whose new subdomain is in the list will be reinitialized. If an empty list is set, then no elements will be reinitialized.
Default:ANY_BLOCK_ID
C++ Type:std::vector<SubdomainName>
Unit:(no unit assumed)
Controllable:No
Description:By default, any element which changes subdomain is reinitialized. If a list of subdomains (IDs or names) is provided, then only elements whose new subdomain is in the list will be reinitialized. If an empty list is set, then no elements will be reinitialized.
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

Advanced Parameters

blocks_fromNames or ids of the 'old' block(s), to be renamed.
C++ Type:std::vector<SubdomainName>
Unit:(no unit assumed)
Controllable:No
Description:Names or ids of the 'old' block(s), to be renamed.
blocks_toNames or ids of the 'new' block.
C++ Type:std::vector<SubdomainName>
Unit:(no unit assumed)
Controllable:No
Description:Names or ids of the 'new' block.
timesThe times of the subdomain modifications.
C++ Type:std::vector<double>
Unit:(no unit assumed)
Controllable:No
Description:The times of the subdomain modifications.

Subdomain Change Data From Input Parameters

blocks_from_column_index1Zero-based index of the blocks_from column. Default is '1'.
Default:1
C++ Type:unsigned long
Unit:(no unit assumed)
Controllable:No
Description:Zero-based index of the blocks_from column. Default is '1'.
blocks_from_column_textHeader text of the blocks_from column.
C++ Type:std::string
Unit:(no unit assumed)
Controllable:No
Description:Header text of the blocks_from column.
blocks_to_column_index2Zero-based index of the blocks_to column. Default is '2'.
Default:2
C++ Type:unsigned long
Unit:(no unit assumed)
Controllable:No
Description:Zero-based index of the blocks_to column. Default is '2'.
blocks_to_column_textHeader text of the blocks_to column.
C++ Type:std::string
Unit:(no unit assumed)
Controllable:No
Description:Header text of the blocks_to column.
comment;Comment character used to parse the file
Default:;
C++ Type:std::string
Unit:(no unit assumed)
Controllable:No
Description:Comment character used to parse the file
data_fileFile holding CSV data
C++ Type:FileName
Unit:(no unit assumed)
Controllable:No
Description:File holding CSV data
delimiter,Delimiter used to parse the file
Default:,
C++ Type:std::string
Unit:(no unit assumed)
Controllable:No
Description:Delimiter used to parse the file
headerFalseIndicates whether the file contains a header with the column names
Default:False
C++ Type:bool
Unit:(no unit assumed)
Controllable:No
Description:Indicates whether the file contains a header with the column names
time_column_index0Zero-based index of the time column. Default is '0'.
Default:0
C++ Type:unsigned long
Unit:(no unit assumed)
Controllable:No
Description:Zero-based index of the time column. Default is '0'.
time_column_textHeader text of the time column.
C++ Type:std::string
Unit:(no unit assumed)
Controllable:No
Description:Header text of the time column.

Subdomain Change Data From Csv File Parameters

(moose/test/tests/meshmodifiers/element_subdomain_modifier/tsm_direct.i)

[Problem]
  solve = false
[]

Box2_inactive_id = '4'
Box3_inactive_id = '5'
Box2_inactive_name = 'Box2_inactive'
Box3_inactive_name = 'Box3_inactive'
inactive_domain_block_ids = '${Box2_inactive_id} ${Box3_inactive_id}'
inactive_domain_block_names = '${Box2_inactive_name} ${Box3_inactive_name}'

[Mesh]
  [BaseMesh]
    type = GeneratedMeshGenerator
    elem_type = TET4
    dim = 3
    nx = 4
    ny = 3
    nz = 2
    xmin = -10
    xmax = 10
    ymin = -10
    ymax = 10
    zmin = -2
    zmax = 2
  []
  [Box1]
    type = SubdomainBoundingBoxGenerator
    input = "BaseMesh"
    block_id = 1
    location = "INSIDE"
    bottom_left = "-20 -20 -2"
    top_right = "20 20 +2"
  []
  [Box2]
    type = SubdomainBoundingBoxGenerator
    input = "Box1"
    block_id = 2
    location = "INSIDE"
    bottom_left = "-4 -3 3"
    top_right = "0 3 0"
  []
  [Box3]
    type = SubdomainBoundingBoxGenerator
    input = "Box2"
    block_id = 3
    location = "INSIDE"
    bottom_left = "0 -3 2"
    top_right = "4 3 0"
  []
  add_subdomain_ids = ${inactive_domain_block_ids}
  add_subdomain_names = ${inactive_domain_block_names}
[]

[AuxVariables]
  [dummy]
    type = MooseVariableFVReal
  []
[]

[MeshModifiers]
  [GlobalSubdomainModifier]
    type = TimedSubdomainModifier
    times = '      0.4            0.6  0.4'
    blocks_from = '2              4    3'
    blocks_to = '  Box2_inactive  2    Box3_inactive' # Subdomain names are permitted ('Box2_inactive' = 4, etc)
    execute_on = 'INITIAL TIMESTEP_BEGIN'
  []
[]

[Executioner]
  dt = 0.1
  type = Transient
  end_time = 1.0
[]

[Outputs]
  exodus = true
[]

(moose/test/tests/meshmodifiers/element_subdomain_modifier/tsm_csv.i)

[Problem]
  solve = false
[]

Box2_inactive_id = '3'
Box2_inactive_name = 'Box2_inactive'
inactive_domain_block_ids = ${Box2_inactive_id}
inactive_domain_block_names = ${Box2_inactive_name}

[Mesh]
  [BaseMesh]
    type = GeneratedMeshGenerator
    elem_type = TET4
    dim = 3
    nx = 5
    ny = 3
    nz = 2
    xmin = -10
    xmax = 10
    ymin = -10
    ymax = 10
    zmin = -2
    zmax = 2
  []
  [Box1]
    type = SubdomainBoundingBoxGenerator
    input = "BaseMesh"
    block_id = 1
    location = "INSIDE"
    bottom_left = "-20 -20 -2"
    top_right = "20 20 2"
  []
  [Box2]
    type = SubdomainBoundingBoxGenerator
    input = "Box1"
    block_id = 2
    location = "INSIDE"
    bottom_left = "-2 -2 2"
    top_right = "2 2 0"
  []
  add_subdomain_ids = ${inactive_domain_block_ids}
  add_subdomain_names = ${inactive_domain_block_names}
[]

[AuxVariables]
  [dummy]
    type = MooseVariableFVReal
  []
[]

# move elements between subdomains back and forth
[MeshModifiers]
  [GlobalSubdomainModifier]
    type = TimedSubdomainModifier
    header = ON
    data_file = 'tsm.csv'
    comment = '#'
    execute_on = 'INITIAL TIMESTEP_BEGIN'
  []
[]

[Executioner]
  type = Transient
  dt = 0.1
  end_time = 1.0
[]

[Outputs]
  exodus = true
[]

(moose/test/tests/meshmodifiers/element_subdomain_modifier/tsm.csv)

time,  block_from,  block_to
0.4,   2,           Box2_inactive   # Subdomain names are permitted 'Box2_inactive' == 3 (as well as comments!)
0.6,   3,           2

Overview
Example Input File Syntax
Input Parameters

TimedSubdomainModifier

Overview

Example Input File Syntax

Vectors of data in the input file

Reading data from CSV file

Input Parameters

Optional Parameters

Advanced Parameters

Subdomain Change Data From Input Parameters

Subdomain Change Data From Csv File Parameters

times

blocks_from

blocks_to

(moose/test/tests/meshmodifiers/element_subdomain_modifier/tsm_direct.i)

data_file

delimiter

comment

header

time_column_text

blocks_from_column_text

blocks_to_column_text

time_column_index

time_column_text

blocks_from_column_index

blocks_from_column_text

blocks_to_column_index

blocks_to_column_text

(moose/test/tests/meshmodifiers/element_subdomain_modifier/tsm_csv.i)

(moose/test/tests/meshmodifiers/element_subdomain_modifier/tsm.csv)