Json input example

In this page, we present an example of a json input

Simulation

{
  "isFile" : true,
  "filenames": ["battery.json",
                "geometry.json",
                "modelSpecification.json",
                "control.json",
                "timeStepping.json",
                "stateInitialization.json"]
}

Battery

{
  "NegativeElectrode": {
    "isFile": true,
    "filename": "negativeElectrode.json"
  },
  "PositiveElectrode": {
    "isFile": true,
    "filename": "positiveElectrode.json"
  },
  "Electrolyte": {
    "isFile": true,
    "filename": "electrolyte.json"
  },
  "Separator": {
    "isFile": true,
    "filename": "separator.json"
  },
  "ThermalModel": {
    "isFile": true,
    "filename": "thermalComponent.json"
  },
  "SOC": 0.9900,
  "initT": 298.1500,
  "use_thermal": true
}

Negative Electrode

{
  "Coating" : {
    "isFile": true,
    "filename" : "coating.json"
  },
  "CurrentCollector" : {
    "isFile": true,
    "filename" : "currentCollector.json"
  }
}

Coating

{
  "ActiveMaterial": {
    "isFile": true,
    "filename" : "activeMaterial.json"
  },
  "Binder": {
    "isFile": true,
    "filename" : "binder.json"
  },
  "ConductingAdditive": {
    "isFile": true,
    "filename" : "conductingAdditive.json"
  },
  
  "effectiveDensity": 1900,
  "bruggemanCoefficient": 1.5,
  "active_material_type": {
    "composite" : false,
    "SEImodel": "none"}
}

Active Material

{
  "Interface": {
    "isFile": true,
    "filename" : "interface.json"
  },
  "SolidDiffusion": {
    "isFile": true,
    "filename" : "solidDiffusion.json"
  },
  "diffusionModelType": "full",
  "electronicConductivity": 100,
  "density": 2240,
  "massFraction": 0.94,
  "thermalConductivity": 1.04,
  "specificHeatCapacity": 632
}

Interface

{
  "saturationConcentration": 30555,
  "volumetricSurfaceArea": 723600,
  "numberOfElectronsTransferred": 1,
  "activationEnergyOfReaction": 5000,
  "reactionRateConstant": 5.031E-11,
  "guestStoichiometry100": 0.88551,
  "guestStoichiometry0": 0.1429,
  "chargeTransferCoefficient": 0.5,
  "openCircuitPotential": {
    "functionFormat": "named function",
    "functionName": "computeOCP_Graphite_Torchio",
    "argumentList": [
      "stoichiometry"
    ]
  },
  "entropyChange": {
    "functionFormat": "named function",
    "functionName": "computeEntropyChange_Graphite_Torchio",
    "argumentList": [
      "stoichiometry"
    ]
  },
  "referenceTemperature": 298.15,
  "density": 2240,
  "includeEntropyChange": true
}

Solid Diffusion

{
  "activationEnergyOfDiffusion": 5000,
  "referenceDiffusionCoefficient": 3.9E-14,
  "particleRadius": 1E-6,
  "volumetricSurfaceArea": 723600
}

Binder

{
  "density": {
    "value": 1.1,
    "unit": "gram/((centi*meter)^3)"
  },
  "massFraction": 0.03,
  "electronicConductivity": 100,
  "specificHeatCapacity": 632,
  "thermalConductivity": 1.04
}

Conducting Additive

{
  "density": {
    "value": 1.95,
    "unit": "gram/((centi*meter)^3)"
  },
  "massFraction": 0.03,
  "electronicConductivity": 100,
  "specificHeatCapacity": 632,
  "thermalConductivity": 1.04 
}

Current Collector

{
  "thickness": 1E-5,
  "N": 2,
  "tab": {
    "width": 0.004,
    "height": 0.001,
    "Nw": 3,
    "Nh": 3
  },
  "electronicConductivity": 5.96E+7,
  "thermalConductivity": 398,
  "specificHeatCapacity": 385,
  "density": 8960
}

Positive Electrode

Here, we provide all the parameter in a single json structure without linking to other files.

{
  "Coating": {
    "effectiveDensity": 3500,
    "bruggemanCoefficient": 1.5,
    "ActiveMaterial": {
      "massFraction": 0.95,
      "density": 4650,
      "specificHeatCapacity": 700,
      "thermalConductivity": 2.1,
      "diffusionModelType": "full",
      "SolidDiffusion": {
        "N": 10,
        "activationEnergyOfDiffusion": 5000,
        "referenceDiffusionCoefficient": 1E-14,
        "particleRadius": 1E-6
      },
      "description": "Lithium Cobalt Oxide (LiCO2) from P. Ramadass, Bala Haran, Parthasarathy M. Gomadam, Ralph White, and Branko N. Popov. \"Development of First Principles Capacity Fade Model for Li-Ion Cells.\" (2004)",
      "Interface": {
        "saturationConcentration": 55555,
        "volumetricSurfaceArea": 885000,
        "density": 4650,
        "numberOfElectronsTransferred": 1,
        "activationEnergyOfReaction": 37480,
        "reactionRateConstant": 2.33E-11,
        "guestStoichiometry100": 0.4955,
        "guestStoichiometry0": 0.99174,
        "chargeTransferCoefficient": 0.5,
        "openCircuitPotential": {
          "functionFormat": "named function",
          "functionName": "computeOCP_LCO",
          "argumentList": [
            "stoichiometry"
          ]
        },
        "entropyChange": {
          "functionFormat": "named function",
          "functionName": "computeEntropyChange_LCO",
          "argumentList": [
            "stoichiometry"
          ]
        },
        "referenceTemperature": 298.15
      },
      "electronicConductivity": 100
    },
    "Binder": {
      "density": 1749.9999999999998,
      "massFraction": 0.025,
      "electronicConductivity": 100,
      "specificHeatCapacity": 700,
      "thermalConductivity": 2.1
    },
    "ConductingAdditive": {
      "density": 1829.9999999999998,
      "massFraction": 0.025,
      "electronicConductivity": 100,
      "specificHeatCapacity": 700,
      "thermalConductivity": 2.1
    }
  },
  "CurrentCollector": {
    "thickness": 1E-5,
    "N": 2,
    "tab": {
      "width": 0.004,
      "height": 0.001,
      "Nw": 3,
      "Nh": 3
    },
    "electronicConductivity": 3.55E+7,
    "thermalConductivity": 170,
    "specificHeatCapacity": 875,
    "density": 2700
  }
}

Electrolyte

{
  "specificHeatCapacity": 2055,
  "thermalConductivity": 0.6,
  "density": 1200,
  "initialConcentration": 1000,
  "ionicConductivity": {
    "functionFormat": "named function",
    "functionName": "computeElectrolyteConductivity_default",
    "argumentList": [
      "concentration",
      "temperature"
    ]
  },
  "diffusionCoefficient": {
    "functionFormat": "named function",
    "functionName": "computeDiffusionCoefficient_default",
    "argumentList": [
      "concentration",
      "temperature"
    ]
  },
  "species": {
    "transferenceNumber": 0.2594,
    "nominalConcentration": 1000
  },
  "bruggemanCoefficient": 1.5
}

Separator

{
  "specificHeatCapacity": 2055,
  "thermalConductivity": 0.6,
  "density": 1200,
  "initialConcentration": 1000,
  "ionicConductivity": {
    "functionFormat": "named function",
    "functionName": "computeElectrolyteConductivity_default",
    "argumentList": [
      "concentration",
      "temperature"
    ]
  },
  "diffusionCoefficient": {
    "functionFormat": "named function",
    "functionName": "computeDiffusionCoefficient_default",
    "argumentList": [
      "concentration",
      "temperature"
    ]
  },
  "species": {
    "transferenceNumber": 0.2594,
    "nominalConcentration": 1000
  },
  "bruggemanCoefficient": 1.5
}

Thermal Model

{
  "externalHeatTransferCoefficientTab": 1000,
  "externalHeatTransferCoefficient": 100,
  "externalTemperature": 298.15
}

Geometry

We consider the 3D demo model, see here

{
  "Geometry": {
    "case": "3D-demo",
    "width": 0.01,
    "height": 0.02,
    "Nw": 10,
    "Nh": 10
  },
  "NegativeElectrode": {
    "Coating": {
      "thickness": 0.0001,
      "N": 3,
      "ActiveMaterial": {
        "SolidDiffusion": {
          "N": 10 }}},
    "CurrentCollector": {
      "thickness": 1e-05,
      "N": 2,
      "tab": {
        "width": 0.004,
        "height": 0.001,
        "Nw": 3,
        "Nh": 3 }}},
  "PositiveElectrode": {
    "Coating": {
      "thickness": 8e-05,
      "N": 3,
      "ActiveMaterial": {
        "SolidDiffusion": {
          "N": 10
        }}},
    "CurrentCollector": {
      "thickness": 1e-05,
      "N": 2,
      "tab": {
        "width": 0.004,
        "height": 0.001,
        "Nw": 3,
        "Nh": 3}}},
  "Separator": {
    "thickness": 5e-05,
    "N": 3 },
  "ThermalModel": {
    "externalHeatTransferCoefficientTab": 1000,
    "externalHeatTransferCoefficient": 100
  }
}

Model Specification

{
  "include_current_collectors": true,
  "use_thermal": true
}

Control

{
  "Control" : {
    "controlPolicy": "CCDischarge",
    "rampupTime": 0.1,
    "DRate": 1,
    "lowerCutoffVoltage": 2.4,
    "upperCutoffVoltage": 4.1,
    "dIdtLimit": 0.01,
    "dEdtLimit": 0.01}}

Time Stepping

{
  "TimeStepping": {
    "numberOfTimeSteps" : 50,
    "useRampup" : true,
    "numberOfRampupSteps" : 4}}

State Initialization

{
  "initializationSetup": "given SOC",
  "initT": 298.15,
  "SOC": 0.99,
  "Electrolyte" : {
    "initialConcentration" : {
      "value": 1,
      "unit": "mol/litre"}}}