ParsedSubdomainMeshModifier

under construction:Undocumented Class

The ParsedSubdomainMeshModifier has not been documented. The content contained on this page 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.

MeshModifier that uses a parsed expression (combinatorial_geometry) to determine if an element (aka its centroid) is inside the combinatorial geometry and assigns a new block id.

Input Parameters

  • combinatorial_geometryFunction expression encoding a combinatorial geometry

    C++ Type:std::string

    Options:

    Description:Function expression encoding a combinatorial geometry

  • block_idSubdomain id to set for inside of the combinatorial

    C++ Type:unsigned short

    Options:

    Description:Subdomain id to set for inside of the combinatorial

Required Parameters

  • excluded_subdomain_idsA set of subdomain ids that will not changed even if they are inside/outside the combinatorial geometry

    C++ Type:std::vector

    Options:

    Description:A set of subdomain ids that will not changed even if they are inside/outside the combinatorial geometry

  • 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)

  • force_prepareFalseNormally all MeshModifiers run before the mesh is prepared for use. This flag can be set on an individual modifier to force preperation 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 preperation between modifiers where they might be needed.

  • 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)

  • block_nameSubdomain name to set for inside of the combinatorial

    C++ Type:SubdomainName

    Options:

    Description:Subdomain name to set for inside of the combinatorial

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

Optional Parameters

  • 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)

  • enableTrueSet the enabled status of the MooseObject.

    Default:True

    C++ Type:bool

    Options:

    Description:Set the enabled status of the MooseObject.

  • 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

  • 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

  • enable_auto_optimizeTrueEnable automatic immediate optimization of derivatives

    Default:True

    C++ Type:bool

    Options:

    Description:Enable automatic immediate optimization of derivatives

  • 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

Advanced Parameters

Input Files

References