SideSetsBetweenSubdomains

under construction:Undocumented Class

The SideSetsBetweenSubdomains has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.


# SideSetsBetweenSubdomains

!syntax description /MeshModifiers/SideSetsBetweenSubdomains

## Overview

!! Replace these lines with information regarding the SideSetsBetweenSubdomains object.

## Example Input File Syntax

!! Describe and include an example of how to use the SideSetsBetweenSubdomains object.

!syntax parameters /MeshModifiers/SideSetsBetweenSubdomains

!syntax inputs /MeshModifiers/SideSetsBetweenSubdomains

!syntax children /MeshModifiers/SideSetsBetweenSubdomains

!syntax description /MeshModifiers/SideSetsBetweenSubdomains

Input Parameters

  • master_blockThe master set of blocks for which to draw a sideset between

    C++ Type:std::vector

    Options:

    Description:The master set of blocks for which to draw a sideset between

  • new_boundaryThe name of the boundary to create

    C++ Type:std::vector

    Options:

    Description:The name of the boundary to create

  • paired_blockThe paired set of blocks for which to draw a sideset between

    C++ Type:std::vector

    Options:

    Description:The paired set of blocks for which to draw a sideset between

Required Parameters

  • depends_onThe MeshModifiers that this modifier relies upon (i.e. must execute before this one)

    C++ Type:std::vector

    Options:

    Description:The MeshModifiers that this modifier relies upon (i.e. must execute before this one)

  • force_prepareFalseNormally all MeshModifiers run before the mesh is prepared for use. This flag can be set on an individual modifier to force preparation between modifiers where they might be needed.

    Default:False

    C++ Type:bool

    Options:

    Description:Normally all MeshModifiers run before the mesh is prepared for use. This flag can be set on an individual modifier to force preparation between modifiers where they might be needed.

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.

Advanced Parameters

Input Files