ParsedAddSideset

under construction:Undocumented Class

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


# ParsedAddSideset

!syntax description /MeshModifiers/ParsedAddSideset

## Overview

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

## Example Input File Syntax

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

!syntax parameters /MeshModifiers/ParsedAddSideset

!syntax inputs /MeshModifiers/ParsedAddSideset

!syntax children /MeshModifiers/ParsedAddSideset

A MeshModifier that adds element's sides to a sideset if the centroid satisfies the combinatorial_geometry expression, (and optionally) if one of the side's elements is in included_subdomain_ids and if it features the correct normal.

Input Parameters

combinatorial_geometryFunction expression encoding a combinatorial geometry
C++ Type:std::string
Options:
Description:Function expression encoding a combinatorial geometry
new_sideset_nameThe name of the new sideset
C++ Type:BoundaryName
Options:
Description:The name of the new sideset

Required Parameters

constant_expressionsVector of values for the constants in constant_names (can be an FParser expression)
C++ Type:std::vector
Options:
Description:Vector of values for the constants in constant_names (can be an FParser expression)
constant_namesVector of constants used in the parsed function (use this for kB etc.)
C++ Type:std::vector
Options:
Description:Vector of constants used in the parsed function (use this for kB etc.)
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)
fixed_normalFalseThis Boolean determines whether we fix our normal or allow it to vary to "paint" around curves
Default:False
C++ Type:bool
Options:
Description:This Boolean determines whether we fix our normal or allow it to vary to "paint" around curves
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.
included_subdomain_idsA set of subdomain ids whose sides will be included in the new sidesets
C++ Type:std::vector
Options:
Description:A set of subdomain ids whose sides will be included in the new sidesets
normal0 0 0If provided specifies the normal vector on sides that are added to the new
Default:0 0 0
C++ Type:libMesh::Point
Options:
Description:If provided specifies the normal vector on sides that are added to the new
variance0.1The variance [0.0 - 1.0] allowed when comparing normals
Default:0.1
C++ Type:double
Options:
Description:The variance [0.0 - 1.0] allowed when comparing normals

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.
disable_fpoptimizerFalseDisable the function parser algebraic optimizer
Default:False
C++ Type:bool
Options:
Description:Disable the function parser algebraic optimizer
enableTrueSet the enabled status of the MooseObject.
Default:True
C++ Type:bool
Options:
Description:Set the enabled status of the MooseObject.
enable_ad_cacheTrueEnable cacheing of function derivatives for faster startup time
Default:True
C++ Type:bool
Options:
Description:Enable cacheing of function derivatives for faster startup time
enable_auto_optimizeTrueEnable automatic immediate optimization of derivatives
Default:True
C++ Type:bool
Options:
Description:Enable automatic immediate optimization of derivatives
enable_jitTrueEnable just-in-time compilation of function expressions for faster evaluation
Default:True
C++ Type:bool
Options:
Description:Enable just-in-time compilation of function expressions for faster evaluation
fail_on_evalerrorFalseFail fatally if a function evaluation returns an error code (otherwise just pass on NaN)
Default:False
C++ Type:bool
Options:
Description:Fail fatally if a function evaluation returns an error code (otherwise just pass on NaN)

Advanced Parameters

Input Files

test/tests/mesh_modifiers/parsed_sideset/parsed_sideset.i

test/tests/mesh_modifiers/parsed_sideset/parsed_sideset.i

[Mesh]
  type = GeneratedMesh
  dim = 3
  nx = 3
  ny = 3
  nz = 3
  xmax = 3
  ymax = 3
  zmax = 3
[]

[MeshModifiers]
  [./subdomains]
    type = ParsedSubdomainMeshModifier
    combinatorial_geometry = 'x < 1 & y > 1 & y < 2'
    block_id = 1
  [../]
  [./sideset]
    type = ParsedAddSideset
    combinatorial_geometry = 'z < 1'
    included_subdomain_ids = '1'
    normal = '1 0 0'
    new_sideset_name = interior
    depends_on = subdomains
  [../]
[]

# This input file is intended to be run with the "--mesh-only" option so
# no other sections are required

Input Parameters
Input Files

Application Usage

Physics and Syntax

Application Development

Framework Development

MOOSEDocs

Infrastructure

Questions

Information and Tools