Skip to content

Filipe charge docs #2594

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

Closed
wants to merge 2 commits into from
Closed

Filipe charge docs #2594

wants to merge 2 commits into from

Conversation

FilipeFcp
Copy link
Contributor

@FilipeFcp FilipeFcp commented Jun 20, 2025

Hi all,
There are some missing classes in the docs, so I am trying to add them.
Please @daquinteroflex , let me know if this is the correct way.
Also, @marc-flex, let me know if there is a reason for these classes not to be in the docs. Also, if you have something in mind to add, let me know.

The compiled HTML are in these links:
1
2
3
4

Greptile Summary

Documentation updates for previously undocumented charge-related classes in Tidy3D, focusing on boundary conditions and mobility models.

  • Fixed mathematical notation in tidy3d/components/tcad/boundary/charge.py, replacing incorrect '\dot' with proper '\cdot' in InsulatingBC documentation
  • Added documentation for ConstantMobilityModel, DCCurrentSource, InsulatingBC, and ParameterPerturbation classes
  • Documentation includes mathematical equations, usage examples, and field descriptions for charge/heat simulation boundary conditions
  • Documentation improvements in FAQ section related to voltage and current boundary conditions
  • Note: TODO comment regarding current source units needs to be addressed

Copy link

@greptile-apps greptile-apps bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

2 files reviewed, no comments
Edit PR Review Bot Settings | Greptile

@marc-flex
Copy link
Contributor

Thanks a lot @FilipeFcp for bringing this up. If the classes aren't in the docs it isn't by design but by omission. So do let us know if you find anything else missing.

In general, we can add classes to the docs by incorporating them somewhere under here: https://github.com/flexcompute/tidy3d/tree/develop/docs/api

I'll create an additional PR to add them

@daquinteroflex
Copy link
Collaborator

Thanks a lot @FilipeFcp ! Sorry just saw now, yes changing the rst like in the other PR is how it fixes the class addition. The math notation looks good thanks for that.

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.

3 participants