Skip to content

Conversation

benflexcompute
Copy link
Collaborator

No description provided.

@benflexcompute benflexcompute changed the title [FXC-3622] Add for UserDefinedFarfield and AutomatedFarfield. [FXC-3622] Add enforced_half_model for UserDefinedFarfield and AutomatedFarfield. Oct 13, 2025
@benflexcompute benflexcompute marked this pull request as ready for review October 17, 2025 16:44
class _FarfieldBase(Flow360BaseModel):
"""Base class for farfield parameters."""

enforced_half_model: Optional[Literal["+y", "-y"]] = (
Copy link
Contributor

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?

Copy link
Contributor

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?

Copy link
Collaborator Author

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?

Copy link
Contributor

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

Copy link
Contributor

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?

Copy link
Collaborator Author

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"...

Copy link
Contributor

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants