CFX example

examples/cfx_static_mixer/project_setup.py

@@ -0,0 +1,179 @@
+"""
+Example script to setup a simple CFX project in pyrep.
+"""
+import argparse
+import logging
+import os
+
+from ansys.rep.client import Client, REPError
+from ansys.rep.client import __external_version__ as ansys_version
+from ansys.rep.client.jms import (
+    File,
+    JmsApi,
+    Job,
+    JobDefinition,
+    Licensing,
+    Project,
+    ProjectApi,
+    ResourceRequirements,
+    Software,
+    SuccessCriteria,
+    TaskDefinition,
+)
+
+log = logging.getLogger(__name__)
+
+
+def create_project(client, name, num_jobs=20, use_exec_script=False):
+    """
+    Create a REP project consisting of an ANSYS CFX model.
+    """
+    jms_api = JmsApi(client)
+    log.debug("=== Project")
+    proj = Project(name=name, priority=1, active=True)
+    proj = jms_api.create_project(proj, replace=True)
+
+    project_api = ProjectApi(client, proj.id)
+
+    log.debug("=== Files")
+    cwd = os.path.dirname(__file__)
+    files = []
+    files.append(
+        File(
+            name="ccl",
+            evaluation_path="runInput.ccl",
+            type="text/plain",
+            src=os.path.join(cwd, "runInput.ccl"),
+        )
+    )
+    files.append(
+        File(
+            name="inp",
+            evaluation_path="StaticMixer_001.cfx",
+            type="application/octet-stream",
+            src=os.path.join(cwd, "StaticMixer_001.cfx"),
+        )
+    )
+    files.append(
+        File(
+            name="def",
+            evaluation_path="StaticMixer_001.def",
+            type="application/octet-stream",
+            src=os.path.join(cwd, "StaticMixer_001.def"),
+        )
+    )
+
+    if use_exec_script:
+        files.append(
+            File(
+                name="exec_cfx",
+                evaluation_path="exec_cfx.py",
+                type="application/x-python-code",
+                src=os.path.join(cwd, "..", "exec_scripts", "exec_cfx.py"),
+            )
+        )
+
+    files.append(
+        File(
+            name="out",
+            evaluation_path="StaticMixer_*.out",
+            type="text/plain",
+            collect=True,
+            monitor=True,
+        )
+    )
+    files.append(
+        File(
+            name="res",
+            evaluation_path="StaticMixer_*.res",
+            type="text/plain",
+            collect=True,
+            monitor=False,
+        )
+    )
+
+    files = project_api.create_files(files)
+    file_ids = {f.name: f.id for f in files}
+
+    log.debug("=== JobDefinition with simulation workflow and parameters")
+    job_def = JobDefinition(name="JobDefinition.1", active=True)
+
+    # Task definition
+    num_input_files = 4 if use_exec_script else 3
+    task_def = TaskDefinition(
+        name="CFX_run",
+        software_requirements=[
+            Software(name="Ansys CFX", version=ansys_version),
+        ],
+        execution_command=None,  # only execution script supported initially
+        resource_requirements=ResourceRequirements(
+            cpu_core_usage=1.0,
+            memory=250,
+            disk_space=5,
+        ),
+        execution_level=0,
+        execution_context={"cfx_cclFile": "runInput.ccl", "cfx_runName": "StaticMixer"},
+        max_execution_time=50.0,
+        num_trials=1,
+        input_file_ids=[f.id for f in files[:num_input_files]],
+        output_file_ids=[f.id for f in files[num_input_files:]],
+        success_criteria=SuccessCriteria(
+            return_code=0,
+            required_output_file_ids=[file_ids["out"]],
+            require_all_output_files=False,
+        ),
+        licensing=Licensing(enable_shared_licensing=False),  # Shared licensing disabled by default
+    )
+
+    if use_exec_script:
+        task_def.use_execution_script = True
+        task_def.execution_command = None
+        task_def.execution_script_id = file_ids["exec_cfx"]
+
+    task_defs = [task_def]
+    task_defs = project_api.create_task_definitions(task_defs)
+
+    job_def.task_definition_ids = [td.id for td in task_defs]
+
+    # Create job_definition in project
+    job_def = project_api.create_job_definitions([job_def])[0]
+
+    job_def = project_api.get_job_definitions()[0]
+
+    log.debug(f"=== Create {num_jobs} jobs")
+    jobs = []
+    for i in range(num_jobs):
+        jobs.append(Job(name=f"Job.{i}", eval_status="pending", job_definition_id=job_def.id))
+    jobs = project_api.create_jobs(jobs)
+
+    log.info(f"Created project '{proj.name}', ID='{proj.id}'")
+
+    return proj
+
+
+if __name__ == "__main__":
+    parser = argparse.ArgumentParser()
+    parser.add_argument("-n", "--name", type=str, default="cfx_static_mixer")
+    parser.add_argument("-j", "--num-jobs", type=int, default=1)
+    parser.add_argument("-es", "--use-exec-script", default=True, action="store_true")
+    parser.add_argument("-U", "--url", default="https://127.0.0.1:8443/rep")
+    parser.add_argument("-u", "--username", default="repadmin")
+    parser.add_argument("-p", "--password", default="repadmin")
+    args = parser.parse_args()
+
+    logger = logging.getLogger()
+    logging.basicConfig(format="%(message)s", level=logging.DEBUG)
+
+    try:
+        log.info("Connect to REP JMS")
+        client = Client(rep_url=args.url, username=args.username, password=args.password)
+        log.info(f"REP URL: {client.rep_url}")
+        proj = create_project(
+            client=client,
+            name=args.name,
+            num_jobs=args.num_jobs,
+            use_exec_script=args.use_exec_script,
+        )
+
+    except REPError as e:
+        log.error(str(e))

examples/cfx_static_mixer/runInput.ccl

@@ -0,0 +1,7 @@
+SIMULATION CONTROL:
+  EXECUTION CONTROL:
+    RUN DEFINITION:
+      Solver Input File = StaticMixer_001.def
+    END
+  END
+END