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

SOF-6892: include new hubbard parameters property #277

Merged
merged 12 commits into from
Dec 8, 2023
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions example/properties_directory/non-scalar/hubbard_parameters.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
{
"name": "hubbard_parameters",
Copy link
Member

Choose a reason for hiding this comment

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

Should we extract hubbard_u and hubbard_v separately as two different properties? Do we ever need to store both together?

And what about J?

Copy link
Member

Choose a reason for hiding this comment

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

hubbard_u, hubbard_v and hubbard_v_nn (add description full name - nearest neighbors)

Copy link
Member Author

Choose a reason for hiding this comment

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

For reference, currently hp.x does not support calculating Hubbard parameters based on DFT+U+J.

"units": "eV",
"category": "hubbard_u",
Copy link
Member

Choose a reason for hiding this comment

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

Can we return to reusable atomic_properties per orbital instead of adding "category"?

# Reusable: atomic_properties_per_orbital
{
    "name": "ANY",
    "values":
    [
        {
            "id": 1,
            "atomicOrbital": {
                // reusing the content of "atomicOrbital" here, maybe not all of it
                "orbitalName": "3S",
                "orbitalIndex": 1,
                "principalNumber": 3,
                "angularMomentum": 0,
                "occupation": 2
            },
            "value": 6.3
        },
        {
            "id": 1,
            "orbitalName": "3S",
            "value": 3.3
        },
        {
            "id": 2,
            "orbitalName": "3P",
            "value": 6.3
        }
    ]
}

Then hubbard_u is a specific implementation of an atomic_properties_per_orbital, so is hubbard_v and hubbard_j?

Copy link
Member Author

Choose a reason for hiding this comment

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

We need to decide. Few things to note:

  1. We have only orbitalName in common. Not sure if it is worth reusing atomicOrbital
  2. It is a per site property (same species on different sites can have different U values). In case of V, it is no longer per site rather inter-site property (V Co-3d O-2p 1 2 0.2), so we are going to have somewhat different schema.
  3. Property names are used in application-flavors/executables/ to specify the results. We do not have different flavors for hp.x, so how do we specify when to use hubbard_u and when hubbard_v result? I created category for this (keeping the same name), which can be populated by the parser depending on the content of hp.x output.

"headers": ["Site no.", "Atomic species", "Orbital/manifold", "U (eV)"],
"values": [
{
"siteNumber": 1,
"atomicSpecies": "Co1",
"orbitalName": "3d",
"value": 6.7553
},
{
"siteNumber": 2,
"atomicSpecies": "Co2",
"orbitalName": "3d",
"value": 6.7553
}
]
}
8 changes: 7 additions & 1 deletion manifest/properties.yaml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
convergence_ionic:
defaults:
units: eV
schemaId: properties-directory/workflow/convergence/ionic
schemaId: properties-directory/workflow/convergence/ionic
isMonitor: true

convergence_electronic:
Expand Down Expand Up @@ -257,3 +257,9 @@ inchi_key:

material:
schemaId: material

hubbard_parameters:
defaults:
units: eV
schemaId: properties-directory/non-scalar/hubbard-parameters
isResult: true
46 changes: 46 additions & 0 deletions schema/properties_directory/non-scalar/hubbard_parameters.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
{
"$id": "properties-directory/non-scalar/hubbard-parameters",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Hubbard parameters",
"description": "Values of Hubbard U, V parameters in eV",
"properties": {
"name": {
"enum": ["hubbard_parameters"]
},
"units": {
"enum": ["eV"]
},
"headers": {
"type": "array",
"items": {
"type": "string"
}
},
"category": {
"enum": ["hubbard_u", "hubbard_v"]
},
"values": {
"type": "array",
"items": {
"type": "object",
"properties": {
"siteNumber": {
"type": "number"
},
"atomicSpecies": {
"type": "string"
},
"orbitalName": {
"type": "string",
"pattern": "^[1-7][sSpPdDfF]$"
},
"value": {
"type": "number",
"description": "Hubbard U values in eV"
}
}
}
}
},
"required": ["name"]
}
Loading