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

Inconsistent capitalization of input params #214

Open
15 tasks
gsgall opened this issue Nov 21, 2023 · 0 comments
Open
15 tasks

Inconsistent capitalization of input params #214

gsgall opened this issue Nov 21, 2023 · 0 comments
Assignees

Comments

@gsgall
Copy link
Collaborator

gsgall commented Nov 21, 2023

Issue

Some objects require inputs where the first letter is capital and others do not. This should be consistent or a convection for capitalization vs non-capitalization should be established for input parameters.

Ex. test/tests/DrifDiffusionAction/RF_Plasma_actions.i

[DriftDiffusionAction]
  [Plasma]
    electrons = em
    charged_particle = Ar+
    Neutrals = Ar*
    mean_energy = mean_en
    potential = potential
    Is_potential_unique = true
    using_offset = false
    position_units = ${dom0Scale}
    Additional_Outputs = 'ElectronTemperature Current EField'
  []
[]

Objects with issues

  • DriftDiffusionAction
  • PeriodicControllers
  • DensityNormalization
  • TM0CylindricalErAux
  • TM0CylindricalEzAux
  • CircuitDirchletPotential
  • DriftDiffusionDoNothingBC
  • MatchedValueLogBC
  • SakiyamaEnergySecondaryElectronBC
  • ArbitraryTiedValueConstraint
  • DriftDiffusion
  • ElectronsFromIonization
  • TM0CylindricalEr
  • TM0CylindricalEz
  • SideCurrent

Proposed Solution

Add deprecation warnings to all of the parameters that have this inconsistency and remove the inconsistent versions of input params after some time.

@gsgall gsgall self-assigned this Mar 4, 2024
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

No branches or pull requests

1 participant