Skip to content

Commit f8027bd

Browse files
committed
Update fun3d_model.py
Delete redundant build_morph method and add documentation to build method.
1 parent efe3c0f commit f8027bd

File tree

1 file changed

+15
-21
lines changed

1 file changed

+15
-21
lines changed

funtofem/interface/caps2fun/fun3d_model.py

+15-21
Original file line numberDiff line numberDiff line change
@@ -37,13 +37,25 @@ def build(
3737
verbosity=0,
3838
):
3939
"""
40-
make a pyCAPS problem with the tacsAIM and egadsAIM on serial / root proc
40+
Make a pyCAPS problem with the tacsAIM and egadsAIM on serial / root proc
4141
Parameters
4242
---------------------------------
4343
csm_file : filepath
44-
filename / full path of ESP/CAPS Constructive Solid Model or .CSM file
44+
Filename / full path of ESP/CAPS Constructive Solid Model or .CSM file.
4545
comm : MPI.COMM
46-
MPI communicator
46+
MPI communicator.
47+
project_name : str
48+
Name of the case that is passed to the flow side, e.g., what is used to name the FUN3D input files.
49+
problem_name : str
50+
CAPS problem name, internal name used to define the CAPS problem and determines the name of the directory
51+
that is created by CAPS to build the fluid mesh, geometry, sensitivity files, etc.
52+
mesh_morph : bool
53+
Turn mesh morphing on or off for use with shape variables that alter the fluid geometry
54+
(e.g., when using mesh deformation rather than remeshing).
55+
root : int
56+
The rank of the processor that will control this process.
57+
verbosity : int
58+
Parameter passed directly to pyCAPS to determine output level.
4759
"""
4860
caps_problem = None
4961
if comm.rank == root:
@@ -55,24 +67,6 @@ def build(
5567
comm.Barrier()
5668
return cls(fun3d_aim, aflr_aim, comm, project_name, root=root)
5769

58-
@classmethod
59-
def build_morph(
60-
cls,
61-
csm_file,
62-
comm,
63-
project_name="fun3d_CAPS",
64-
root: int = 0,
65-
problem_name: str = "capsFluid",
66-
):
67-
return cls.build(
68-
csm_file=csm_file,
69-
comm=comm,
70-
project_name=project_name,
71-
problem_name=problem_name,
72-
root=root,
73-
mesh_morph=True,
74-
)
75-
7670
@property
7771
def root_proc(self) -> bool:
7872
return self.fun3d_aim.root_proc

0 commit comments

Comments
 (0)