-
Notifications
You must be signed in to change notification settings - Fork 9
[FXC-3622] Add enforced_half_model
for UserDefinedFarfield and AutomatedFarfield.
#1491
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
[FXC-3622] Add enforced_half_model
for UserDefinedFarfield and AutomatedFarfield.
#1491
Conversation
enforced_half_model
for UserDefinedFarfield and AutomatedFarfield.
class _FarfieldBase(Flow360BaseModel): | ||
"""Base class for farfield parameters.""" | ||
|
||
enforced_half_model: Optional[Literal["+y", "-y"]] = ( |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Rename to enforce_half_model
?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This choice means that if we want to enforce full-body in the future, we'll have to change this interface again. Isn't using the enum approach more future-proof, since then we just have to deprecate the "auto" option for the domain_type?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
How about "enforce_domain_type"? "enforce" as we are overriding the default behavior and changing the geometry/surface mesh?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes, I like it. Let's do enforce_domain_type
as the parameter name. What about the options?
full_body
half_body_positive_y
half_body_negative_y
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We don't need auto
option since this parameter is Optional
. In the future we just need to make it required then?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I need to think more since in the future if we deprecate "auto" then there is nothing we are "enforcing" against? I guess against "auto symmetry" instead of "cut symmetry"?
Maybe it is best to just call "domain_type"...
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah good point. Maybe domain_type
is just clearer. In the description we can say that this option is meant to override the "auto symmetry" behavior for now.
No description provided.