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

Add theory documentation for different numerical methods and physics modules in svFSIplus #33

Open
1 task done
JonathanPham opened this issue Oct 25, 2024 · 5 comments
Assignees
Labels
enhancement New feature or request

Comments

@JonathanPham
Copy link
Contributor

Problem

Need to add theory documentation for different numerical methods and physics modules in svFSIplus

Solution

Add theory documentation for different numerical methods and physics modules in svFSIplus

Additional context

No response

Code of Conduct

  • I agree to follow this project's Code of Conduct and Contributing Guidelines
@JonathanPham JonathanPham added the enhancement New feature or request label Oct 25, 2024
@JonathanPham JonathanPham mentioned this issue Oct 30, 2024
1 task
@ktbolt
Copy link
Contributor

ktbolt commented Oct 30, 2024

@JonathanPham It is a good practice to describe in the Issue what work you did and any problems you had.

For example, did you encounter any problems with MathJax ?

@JonathanPham
Copy link
Contributor Author

JonathanPham commented Oct 30, 2024

For the fluid theory, I converted some Latex documentation I previously wrote in Overleaf over to MathJax. Some issues I encountered:

  • for time derivatives, \dot{x} was not working well in MathJax (not sure why), so I used \frac{dx}{dt} instead
  • square brackets (\left[...\right]) were not working well in MathJax (not sure why), so I avoided using those
  • to write multiple aligned equations in Latex, use \begin{align} ... \end{align}. In MathJax, use \begin{aligned} ... \end{aligned}
  • to use curly brackets {...}, use \\{...\\} instead of \{...\}

@JonathanPham
Copy link
Contributor Author

JonathanPham commented Oct 30, 2024

Additional physics theories that need to be added:

  • solid mechanics (struct and ustruct)
  • electrophysiology
  • heat equation
  • advection-diffusion

@JonathanPham
Copy link
Contributor Author

JonathanPham commented Oct 31, 2024

Additional numerical methods that could be added:

  • finite element method overview
  • generalized-alpha time integration
  • linear solver methods

@ktbolt
Copy link
Contributor

ktbolt commented Nov 7, 2024

The Fluid mechanics section should just describe the finite element formulation for incompressible flow without all of the Brinkman terms. This just adds a bunch of terms that don't have any meaning for users doing CFD.

As far as I know there is currently no one using flow in porous media. But if we really do want to support it then we should add documentation for it (the Inverse_darcy_permeability parameter is not even documented). We can then add a theory section for it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants