ImageMeshGenerator

Description

The ImageMeshGenerator object is a convenience tool for setting up a mesh to match the pixel structure of a two or three dimensional image. It is generally used in union with the ImageFunction object to perform simulations that rely on image data, such as setting up an initial condition of a grain structure. By default the generated mesh is sized to the dimensions of the images and creates one element per pixel.

Input Parameters

• file_suffixSuffix of the file to open, e.g. 'png'

C++ Type:std::string

Options:

Description:Suffix of the file to open, e.g. 'png'

• scale_to_oneTrueWhether or not to scale the image so its max dimension is 1

Default:True

C++ Type:bool

Options:

Description:Whether or not to scale the image so its max dimension is 1

• zmax1Upper Z Coordinate of the generated mesh

Default:1

C++ Type:double

Options:

Description:Upper Z Coordinate of the generated mesh

• ymax1Upper Y Coordinate of the generated mesh

Default:1

C++ Type:double

Options:

Description:Upper Y Coordinate of the generated mesh

• cells_per_pixel1The number of mesh cells per pixel, must be <=1

Default:1

C++ Type:double

Options:

Description:The number of mesh cells per pixel, must be <=1

Default:False

C++ Type:bool

Options:

• zmin0Lower Z Coordinate of the generated mesh

Default:0

C++ Type:double

Options:

Description:Lower Z Coordinate of the generated mesh

• file_baseImage file base to open, use this option when a stack of images must be read (ignored if 'file' is given)

C++ Type:FileNameNoExtension

Options:

Description:Image file base to open, use this option when a stack of images must be read (ignored if 'file' is given)

• nz1Number of elements in the Z direction

Default:1

C++ Type:unsigned int

Options:

Description:Number of elements in the Z direction

• bias_y1The amount by which to grow (or shrink) the cells in the y-direction.

Default:1

C++ Type:double

Options:

Description:The amount by which to grow (or shrink) the cells in the y-direction.

• nx1Number of elements in the X direction

Default:1

C++ Type:unsigned int

Options:

Description:Number of elements in the X direction

• ny1Number of elements in the Y direction

Default:1

C++ Type:unsigned int

Options:

Description:Number of elements in the Y direction

• bias_z1The amount by which to grow (or shrink) the cells in the z-direction.

Default:1

C++ Type:double

Options:

Description:The amount by which to grow (or shrink) the cells in the z-direction.

• fileName of single image file to extract mesh parameters from. If provided, a 2D mesh is created.

C++ Type:FileName

Options:

Description:Name of single image file to extract mesh parameters from. If provided, a 2D mesh is created.

• xmin0Lower X Coordinate of the generated mesh

Default:0

C++ Type:double

Options:

Description:Lower X Coordinate of the generated mesh

• file_rangeRange of images to analyze, used with 'file_base' (ignored if 'file' is given)

C++ Type:std::vector

Options:

Description:Range of images to analyze, used with 'file_base' (ignored if 'file' is given)

• ymin0Lower Y Coordinate of the generated mesh

Default:0

C++ Type:double

Options:

Description:Lower Y Coordinate of the generated mesh

• xmax1Upper X Coordinate of the generated mesh

Default:1

C++ Type:double

Options:

Description:Upper X Coordinate of the generated mesh

• bias_x1The amount by which to grow (or shrink) the cells in the x-direction.

Default:1

C++ Type:double

Options:

Description:The amount by which to grow (or shrink) the cells in the x-direction.

• elem_typeThe type of element from libMesh to generate (default: linear element for requested dimension)

C++ Type:MooseEnum

Description:The type of element from libMesh to generate (default: linear element for requested dimension)

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.