fluidsimfoam.foam_input_files

OpenFOAM input files

AST and parser

ast	Abstract Syntax Trees for OpenFOAM input files
generators	Internal machinery to generate the OpenFOAM input files
parser	Parser for OpenFOAM input files
format	Format OpenFOAM input files

Helper to create input files

blockmesh	Helper to create blockMeshDict files
control_dict	Helper to create controlDict files
fields	Helper to create field files
fv_schemes	Helper to create fvSchemes files
constant_files	Helper to create constant files
fv_options	Helper to create fvOptions files
decompose_par	Helper to create decomposeParDict files
util	Utilities

Functions

parse_header(code)	Parse the header ("FoamFile" entry) of an OpenFOAM file
read_header(path)	Read the header ("FoamFile" entry) of an OpenFOAM file

Classes

FileHelper()

Abstract class for "Helper" objects

fluidsimfoam.foam_input_files.parse(text, grammar=None)

fluidsimfoam.foam_input_files.dump(tree)

fluidsimfoam.foam_input_files.create_field_from_code(code)

class fluidsimfoam.foam_input_files.FoamInputFile(info, children=None, header=None, comments=None)

dump()

overwrite()

class fluidsimfoam.foam_input_files.ControlDictHelper(default=None)

complete_params(params)

Complete the params object

make_tree(params)

Make the AST corresponding to a file

new(default=None)

add_function(key, type, libs, entries=None)

include_function(name, kind=None)

include_functions(names, kind=None)

class fluidsimfoam.foam_input_files.Dict(data, name=None, directive=None, comments=None)

get_name()

dump(indent=0)

class fluidsimfoam.foam_input_files.List(iterable=None, name=None, dtype=None)

Represents an OpenFoam list

get_name()

dump(indent=0)

class fluidsimfoam.foam_input_files.Value(value, name=None, dimension=None)

dump_without_assignment(indent=0)

class fluidsimfoam.foam_input_files.BlockMeshDict

set_metric(metric)

set self.comvert_to_meters by word

set_scale(scale)

add_vertex(x, y=None, z=None, name=None)

add vertex by coordinate and uniq name x y z is coordinates of vertex name is uniq name to refer the vertex returns Vertex object whici is added.

del_vertex(name)

del name key from self.vertices

reduce_vertex(name1, *names)

treat name1, name2, … as same point.

name2.alias, name3.alias, … are merged with name1.alias the key name2, name3, … in self.vertices are kept and mapped to same Vertex instance as name1

merge_vertices()

call reduce_vertex on all vertices with identical values.

replicate_vertices_further_z(z, suffix='_dz', vnames=None)

Helper for 2d meshes

add_hexblock(vnames, nx_ny_nz, name=None, grading=<fluidsimfoam.foam_input_files.blockmesh.grading.SimpleGrading object>)

add_hexblock_from_2d(vnames, nx_ny_nz, name=None, grading=<fluidsimfoam.foam_input_files.blockmesh.grading.SimpleGrading object>, suffix_zm='', suffix_zp='_dz')

add_arcedge(vnames, name, inter_vertex)

add_splineedge(vnames, name, points)

add_boundary(type_, name, faces=None, neighbour=None)

add_merge_patch_pairs(boundary_name1: str, boundary_name2: str)

Add 2 boundaries to merge

add_cyclic_boundaries(name0, name1, faces0, faces1)

Add 2 cyclic boundaries

Example

2 cyclic boundaries can be created as follow:

add_cyclic_boundaries("outlet", "inlet", b0.face("e"), b0.face("w"))

assign_vertexid(sort=True)

1. create list of Vertex which are referred by blocks only.

2. sort vertex according to (x, y, z)

3. assign sequence number for each Vertex

4. sorted list is saved as self._vertices_in_blockmesh

format_vertices_section()

format vertices section. assign_vertexid() should be called before this method, because self._vertices_in_blockmesh should be available and members of self._vertices_in_blockmesh should have valid index.

format_blocks_section()

format blocks section. assign_vertexid() should be called before this method, because vertices refered by blocks should have valid index.

format_edges_section()

format edges section. assign_vertexid() should be called before this method, because vertices refered by blocks should have valid index.

format_boundary_section()

format boundary section. assign_vertexid() should be called before this method, because vertices refered by faces should have valid index.

format_mergepatchpairs_section()

format(header='/*--------------------------------*- C++ -*----------------------------------*\\\n| =========                 |                                                 |\n| \\\\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox           |\n|  \\\\    /   O peration     | Version:  v2206                                 |\n|   \\\\  /    A nd           | Website:  www.openfoam.com                      |\n|    \\\\/     M anipulation  |                                                 |\n\\*---------------------------------------------------------------------------*/', sort_vortices=True)

class fluidsimfoam.foam_input_files.VolScalarField(name, dimension, tree=None, values=None)

cls_name: str = 'volScalarField'

set_values(values)

Set internalField with value(s)

class fluidsimfoam.foam_input_files.VolVectorField(name, dimension, tree=None, values=None)

cls_name: str = 'volVectorField'

set_values(values, vy=None, vz=None)

Set internalField with value(s)

get_components()

class fluidsimfoam.foam_input_files.FvSchemesHelper(ddt=None, grad=None, div=None, laplacian=None, interpolation=None, sn_grad=None)

keys = ['ddt', 'grad', 'div', 'laplacian', 'interpolation', 'snGrad']

complete_params(params)

Complete the params object

make_tree(params)

Make the AST corresponding to a file

add_dict(name, data)

class fluidsimfoam.foam_input_files.Vertex(x, y, z, name, index=None)

format()

copy()

fluidsimfoam.foam_input_files.read_field_file(path, skip_boundary_field=True)

class fluidsimfoam.foam_input_files.FileHelper

Abstract class for “Helper” objects

abstract complete_params(params)

Complete the params object

abstract make_tree(params)

Make the AST corresponding to a file

class fluidsimfoam.foam_input_files.ConstantFileHelper(file_name: str, default: dict, default_dimension: str = False, dimensions: Optional[dict] = None, comments: Optional[dict] = None, doc: Optional[str] = None, cls: str = 'dictionary', dimension=None)

complete_params(params)

Complete the params object

make_tree(params)

Make the AST corresponding to a file

class fluidsimfoam.foam_input_files.BlockMeshDictRectilinear(lx, ly, lz, nx, ny, nz, scale)

class fluidsimfoam.foam_input_files.FvOptionsHelper

add_option(type, name=None, active=True, cell_zone=None, cell_set=None, points=None, default=None, coeffs=None, parameters=None, only_if_active=False)

remove_option(name)

complete_params(params)

Complete the params object

make_tree(params)

Make the AST corresponding to a file

class fluidsimfoam.foam_input_files.DimensionSet(foam_units)

dump_without_assignment(indent=0)

class fluidsimfoam.foam_input_files.DecomposeParDictHelper(nsubdoms=1, method='scotch', key_in_params='parallel')

add_region(name, data)

complete_params(params)

Complete the params object

make_tree(params)

Make the AST corresponding to a file

new(nsubdoms=None, method=None, key_in_params=None)

fluidsimfoam.foam_input_files.format_code(code, as_field=False, check=True)

exception fluidsimfoam.foam_input_files.FoamFormatError

fluidsimfoam.foam_input_files.read_header(path)

Read the header (“FoamFile” entry) of an OpenFOAM file

fluidsimfoam.foam_input_files.parse_header(code: str)

Parse the header (“FoamFile” entry) of an OpenFOAM file