Skip to content

module myna.application.additivefoam.solidification_region_reduced.app

Defines application behavior for the additivefoam/solidification_region_reduced simulation type

class AdditiveFOAMRegionReduced

Simulation type for generating solidification data for specified regions

method AdditiveFOAMRegionReduced.__init__

__init__(name='solidification_region_reduced')

method AdditiveFOAMRegionReduced.can_use_existing_mesh_resource

can_use_existing_mesh_resource(case_dict)

Checks if there is a valid mesh in the resource template directory.

This saves time during configuration, because AdditiveFOAM cases for the same region in consecutive layers can reuse the same mesh.

Args:

  • case_dict: (dict) defines the build, part, region, and layer names

Returns: (bool) True/False

method AdditiveFOAMRegionReduced.clean_parallel_case

clean_parallel_case(case_dict)

Removes parallel files

method AdditiveFOAMRegionReduced.configure

configure()

Configure all cases for the application

method AdditiveFOAMRegionReduced.configure_case

configure_case(mynafile)

Create a valid AdditiveFOAM case directory based on the myna_data.yaml file

method AdditiveFOAMRegionReduced.construct_case_mesh_dict

construct_case_mesh_dict(case_dict)

Constructs a dictionary that contains all of the information defining the mesh for the specified case directory

Args:

  • case_dict: (dict) defines the build, part, and region for a case

Returns: (dict) mesh properties

method AdditiveFOAMRegionReduced.construct_rve_mesh_dict

construct_rve_mesh_dict(region_dict)

Constructs a dictionary with inputs needed for RVE mesh generation

Args:

  • region_dict: (dict) parameters for defining the region location

Returns: (dict) dictionary including bounding box info for layer and RVE refinement regions

method AdditiveFOAMRegionReduced.create_coarse_mesh

create_coarse_mesh(case_dict)

Creates the coarse mesh

Args:

  • case_dict: (dict) describes the case settings, from self.parse_mynafile_path_to_dict()

method AdditiveFOAMRegionReduced.execute

execute()

Execute all cases for the application.

method AdditiveFOAMRegionReduced.execute_case

execute_case(mynafile)

Run an AdditiveFOAM case using the specified number of cores and batch option

Args:

  • mynafile: (str) path to the expected Myna file for the case

Returns:

  • process: (subprocess.Popen) if batch==True, the associated Popen object, else None

method AdditiveFOAMRegionReduced.generate_resource_mesh

generate_resource_mesh(case_dict)

Generates the mesh in the resource template directory based on the given case and mesh setting dictionaries

Args:

  • case_dict: (dict) describes the case settings, from self.parse_mynafile_path_to_dict()

method AdditiveFOAMRegionReduced.parse_configure_arguments

parse_configure_arguments()

Check for arguments relevant to the configure step and update app settings

method AdditiveFOAMRegionReduced.parse_mynafile_path_to_config_dict

parse_mynafile_path_to_config_dict(mynafile)

Parses the path of the output Myna file into a dictionary containing the build, part, region, and layer names. Additionally adds mesh information based on configuration arguments.

Path to the Myna file is expected to be in the format: working_dir/build/part/region/layer/stepname/mynafile

method AdditiveFOAMRegionReduced.parse_mynafile_path_to_dict

parse_mynafile_path_to_dict(mynafile)

Parses the path of the output Myna file into a dictionary containing the build, part, region, and layer names.

Path to the Myna file is expected to be in the format: working_dir/build/part/region/layer/stepname/mynafile

method AdditiveFOAMRegionReduced.postprocess

postprocess()

Postprocesses all cases

method AdditiveFOAMRegionReduced.postprocess_case

postprocess_case(mynafile)

Postprocess a case to generate the valid Myna file

Args:

  • mynafile: (str) path to the Myna file for the case

method AdditiveFOAMRegionReduced.refine_layer_mesh

refine_layer_mesh(case_dict)

Refines the coarse mesh

Args:

  • case_dict: (dict) describes the case settings, from self.parse_mynafile_path_to_dict()

method AdditiveFOAMRegionReduced.refine_region_mesh

refine_region_mesh(case_dict)

Refines the already refined layer mesh in the region for the case

Args:

  • case_dict: (dict) describes the case settings, from self.parse_mynafile_path_to_dict()

method AdditiveFOAMRegionReduced.update_case_metadata

update_case_metadata(case_dict)

Updates case settings based on Myna information

Args:

  • case_dict: (dict) case information, from self.self.parse_mynafile_path_to_dict()

This file was automatically generated via lazydocs.