Skip to content
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

📚[DOC]: Further explanation and more examples on integral parts and normal_dot_vel needed #144

Open
DJopek opened this issue Mar 29, 2024 · 0 comments
Labels
? - Needs Triage Need team to review and classify documentation Improvements or additions to documentation external Issues/PR filed by people outside the core team

Comments

@DJopek
Copy link

DJopek commented Mar 29, 2024

How would you describe the priority of this documentation request

Critical (currently preventing usage)

Is this for new documentation, or an update to existing docs?

New

Describe the incorrect/future/missing documentation

In the examples we can find the aneurysm example where is considered integral continuity. Although in the documentation nor in the code there is no further explanation of the idea behind that. In the code we can find

`    
# Integral Continuity 2
integral_continuity = IntegralBoundaryConstraint(
    nodes=nodes,
    geometry=integral_mesh,
    outvar={"normal_dot_vel": -2.540},
    batch_size=1,
    integral_batch_size=cfg.batch_size.integral_continuity,
    lambda_weighting={"normal_dot_vel": 0.1},
)
domain.add_constraint(integral_continuity, "integral_continuity_1")

# Integral Continuity 1
integral_continuity = IntegralBoundaryConstraint(
    nodes=nodes,
    geometry=outlet_mesh,
    outvar={"normal_dot_vel": 2.540},
    batch_size=1,
    integral_batch_size=cfg.batch_size.integral_continuity,
    lambda_weighting={"normal_dot_vel": 0.1},
)
domain.add_constraint(integral_continuity, "integral_continuity_1")`

It would be helpful to understand why it is setup in such specific way, using two integral continuity and why are there opposite signs of normal_dot_vel (I assume that one is for inflow and the other is for outflow). As well further explanation of how to physically interpret the normal_dot_vel and how to handle in the code would be appreciated.

If this is a correction, please provide a link to the incorrect documentation. If this is a new documentation request, please link to where you have looked.

https://docs.nvidia.com/deeplearning/modulus/modulus-sym/user_guide/intermediate/adding_stl_files.html

@DJopek DJopek added ? - Needs Triage Need team to review and classify documentation Improvements or additions to documentation labels Mar 29, 2024
@DJopek DJopek changed the title 📚[DOC]: Further explanation and more examples on integral parts and normal_dot_vel 📚[DOC]: Further explanation and more examples on integral parts and normal_dot_vel needed Mar 29, 2024
@prem-krishnan prem-krishnan added the external Issues/PR filed by people outside the core team label Jun 4, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
? - Needs Triage Need team to review and classify documentation Improvements or additions to documentation external Issues/PR filed by people outside the core team
Projects
None yet
Development

No branches or pull requests

2 participants