Restructure AddSourceTermsMultiGroup

[chongchonghe]

Description

In this PR I attempt to make the AddSourceTermsMultiGroup function more structured.

Now, AddSourceTermsMultiGroup looks like this:

AddSourceTermsMultiGroup()
{
  // declare variables
  ...
    
  for outer loop {
    // declare variables
    ...
      
    // Compute the gas and radiation energy update. This also updates the opacities. When ite == 0, this also computes the work term.
    if (enable_dust_gas_thermal_coupling_model_) {
      updated_energy = SolveMatterRadiationEnergyExchange(..., &ComputeJacobianForGasAndDust, &ComputeDustTemperatureBateKeto);
    } else {
      updated_energy = SolveMatterRadiationEnergyExchange(..., &ComputeJacobianForGas, &ComputeDustTemperatureGasOnly);
    }
    
    // Compute radiation flux update
    ...
      
    // Deal with the work term.
    ...
  }
}

and this is the only place where enable_dust_gas_thermal_coupling_model_ is used.

Next, hopefully, I can implement more complex dust models and cooling/heating by defining new ComputeJacobian and new ComputeDustTemperature.

Related issues

N/A

Checklist

Before this pull request can be reviewed, all of these tasks should be completed. Denote completed tasks with an x inside the square brackets [ ] in the Markdown source below:

• I have added a description (see above).
• I have added a link to any related issues see (see above).
• I have read the Contributing Guide.
• I have added tests for any new physics that this PR adds to the code.
• I have tested this PR on my local computer and all tests pass.
• I have manually triggered the GPU tests with the magic comment /azp run.
• I have requested a reviewer for this PR.

[azure-pipelines]

Azure Pipelines successfully started running 2 pipeline(s).

[chongchonghe]

/azp run

[azure-pipelines]

Azure Pipelines successfully started running 2 pipeline(s).

[chongchonghe]

/azp run

[azure-pipelines]

Azure Pipelines successfully started running 2 pipeline(s).

[BenWibking]

I think this is a good improvement and much better structured. I haven't gone through each line yet.

Did you intend to make the same changes to AddSourceTermsSingleGroup and AddSourceTermsMultiGroup? It looks like you've made similar changes, but I haven't compared them line-by-line.

There is a lot of commented-out code. Is it necessary to keep that? Otherwise, I think it would be a lot cleaner to just remove it.

[chongchonghe]

Did you intend to make the same changes to AddSourceTermsSingleGroup and AddSourceTermsMultiGroup? It looks like you've made similar changes, but I haven't compared them line-by-line.

No, I did not do the same thing to AddSourceTermsSingleGroup and I don't intend to. I think AddSourceTermsSingleGroup is simple enough and I won't make much change to it in the future, so It's probably not worth doing it.

There is a lot of commented-out code. Is it necessary to keep that? Otherwise, I think it would be a lot cleaner to just remove it.

I see only one commented-out code (just before using SolveMatterRadiationEnergyExchange) and I meant to keep it for future reference.

[chongchonghe]

/azp run

[azure-pipelines]

Azure Pipelines successfully started running 2 pipeline(s).

[BenWibking]

This looks good.

It would be useful to have the ordering of the variables used to define the Jacobian matrix listed in a comment next to the definition of JacobianResult.

[sonarqubecloud]

Quality Gate passed

Issues
23 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
14.0% Duplication on New Code

See analysis details on SonarCloud