API-Programmierreferenz: Skriptbeispiel "Cutplane" (Schnittebene)
Im folgenden Thema wird die Programmierreferenz anhand des Beispielskripts cut_plane.py beschrieben. (Dieses Skript ist Bestandteil der API-Programmierreferenz.)
Zu jeder Zeile (bzw. jedem Zeilenblock) gibt es eine ausführliche Beschreibung und Verweise auf den entsprechenden Abschnitt der Programmierreferenz.
Beispielskript
from CFD import Konfiguration
from CFD import Results
from CFD import DSE
study = Setup.DesignStudy.Create()
scenario = study.getactivescenario()
results = scenario.results()
results.activate()
params = Results.CutPlaneParameters()
location = Setup.Vector(0, 0.02, 0)
normal = Setup.Vector(0, 1, 0)
params.scalarResType = Results.VELOCITY_MAG
cp = Results.CutPlane.Create(results, "Cutplane1", location, normal, params)
DSE.UI.ShowMessage("Cutplane created!")
Beschreibung der Skriptabschnitte
from CFD import Konfiguration
from CFD import Results
from CFD import DSE
> Im Header-Abschnitt muss jedes im Skript referenzierte Modul deklariert werden. Alle sind Teil des CFD-Projekts. Klicken Sie in der Programmierreferenz auf Module, um die Liste der Module aufzurufen:
study = Setup.DesignStudy.Create()
> In dieser Zeile wird eine Variable namens study deklariert. Sie referenziert die Methode Create der Klasse DesignStudy im Modul Konfiguration. So meistern Sie auch die Designstudie. Es ist nicht erforderlich, den Namen der Designstudie anzugeben, da während einer Autodesk®-CFD-Sitzung nur eine Studie geöffnet ist.
Klicken Sie auf der Seite Modules auf Konfiguration. Die folgende Seite wird angezeigt:
scenario = study.getactivescenario()
> In dieser Zeile wird das aktive Szenario in der Studie abgerufen. Da es zu einem gegebenen Zeitpunkt nur ein aktives Szenario gibt, ist es nicht erforderlich, den Namen des Szenarios anzugeben. Dies gilt allerdings nicht, wenn Sie ein anderes als das geöffnete Szenario referenzieren.
results = scenario.results()
> Hier werden die Ergebnisse des Szenarios abgerufen.
results.activate()
> Mit diesem Befehl werden die aktuellen Ergebnisse aktiviert.
params = Results.CutPlaneParameters()
> Hier werden die für die Ergebnisebene erforderlichen Parameter initialisiert. Klicken Sie auf der Seite Modul auf Ergebnisse, um auf die Klasse CutPlaneParameters zuzugreifen:
location = Setup.Vector(0, 0.02, 0)
> Definiert eine Variable namens „location“ und gibt die Position der Ebene an der durch Y = 0.02 definierten Ebene vor. "Vector" ist eine Klasse innerhalb des Moduls "Konfiguration".
normal = Setup.Vector(0, 1, 0)
> Definiert eine Variable namens „normal“ und gibt die Ausrichtung der Ebene als Normale zur Y-Achse vor.
params.scalarResType = Results.VELOCITY_MAG
> Legt „Geschwindigkeitsbetrag“ als Typ der auf der Ergebnisebene angezeigten Skalare fest. "ScalarResType" ist eine Klasse unter "CutPlaneParameters":
Um die Liste der verfügbaren Enumeratoren anzuzeigen, klicken Sie auf den Link "ScalarResType". VELOCITY_MAG ist der Enumerator für Geschwindigkeitsbetrag-Skalare:
cp = Results.CutPlane.Create(results, "Cutplane1", location, normal, params)
> Erstellt die Ergebnisebene unter Verwendung der oben definierten Argumente. Der Befehl referenziert die Methode Create der Klasse CutPlane im Modul Ergebnisse:
- Die Zeichenfolge "Cutplane1"
- location und normal sind die bereits früher definierten Variablen.
- Die Variable params mit allen Einstellungen für die Ebene.
Die Argumentliste wird aus der oben beschriebenen Variablen results geformt, um die Ergebnisse des Szenarios abzurufen. Der Name der Schnittebene wird wie folgt definiert:
DSE.UI.ShowMessage("Cutplane created!")
> Zeigt die Meldung "Cutplane created" in der Ausgabeleiste der Benutzeroberfläche an. Dieser Befehl referenziert das Modul DSE, die Klasse UI und die Methode ShowMessage:
Verwandte Themen