Custom solver not registered.

[uttamcadambi07]

Hi.

i am using dafoam version 3.0.6. I want to make a custom solver so followed the instructions that were on the workshop slides. Making all the changes to stateinfo, residual and adding all these to the make files. Finally i also added the new solver name to the _solverRegistry in pyDAFoam.py. I stoll get this error

+------------------------------------------------------------------------------+
| pyDAFoam Error: pyDAFoam: DABoxAvgFoam not registered! Check               |
| _solverRegistry(self).                                                       |
+------------------------------------------------------------------------------+


+------------------------------------------------------------------------------+
| pyDAFoam Error: pyDAFoam: DABoxAvgFoam not registered! Check               |
| _solverRegistry(self).                                                       |
+------------------------------------------------------------------------------+

Traceback (most recent call last):
  File "sample_run.py", line 169, in <module>
    DASolver = PYDAFOAM(options=daOptions, comm=gcomm)
  File "/home/uttamcadambi/dafoam_v2/packages/miniconda3/lib/python3.8/site-packages/dafoam/pyDAFoam.py", line 745, in __init__
    self._initSolver()
  File "/home/uttamcadambi/dafoam_v2/packages/miniconda3/lib/python3.8/site-packages/dafoam/pyDAFoam.py", line 2829, in _initSolver
    raise Error("pyDAFoam: %s not registered! Check _solverRegistry(self)." % solverName)
dafoam.pyDAFoam.Error
Traceback (most recent call last):
  File "sample_run.py", line 169, in <module>
    DASolver = PYDAFOAM(options=daOptions, comm=gcomm)
  File "/home/uttamcadambi/dafoam_v2/packages/miniconda3/lib/python3.8/site-packages/dafoam/pyDAFoam.py", line 745, in __init__
    self._initSolver()
  File "/home/uttamcadambi/dafoam_v2/packages/miniconda3/lib/python3.8/site-packages/dafoam/pyDAFoam.py", line 2829, in _initSolver
    raise Error("pyDAFoam: %s not registered! Check _solverRegistry(self)." % solverName)
dafoam.pyDAFoam.Error

But my solver registry looks like this

    def _solverRegistry(self):
        """
        Register solver names and set their types. For a new solver, first identify its
        type and add their names to the following dict
        """

        self.solverRegistry = {
            "Incompressible": ["DASimpleFoam", "DASimpleTFoam", "DAPisoFoam", "DAPimpleFoam", "DAPimpleDyMFoam", "DABoxAvgFoam"],
            "Compressible": ["DARhoSimpleFoam", "DARhoSimpleCFoam", "DATurboFoam"],
            "Solid": ["DASolidDisplacementFoam", "DALaplacianFoam", "DAScalarTransportFoam"],
        }

The last one is DABoxAvgFoam is the new solver and i do Allmake incompressible only.

What else can I check?

[uttamcadambi07]

A strange thing happened.

I removed DASimpleFoam from the registry and re-compiled dafoam. I am still able to use the solver DASimpleFoam even if it is not in the solverRegistry list in pyDAFoam.py. But even if I add the new solver in the list, it is not able to recognize it. So this means that the solverRegistry initialization has to take place somewhere else other than in solverRegistry_ in pyDAFoam.py.

[friedenhe]

It seems that you did not run pip install . after modifying the pyDAFoam.py file.

[uttamcadambi07]

I did it and found my package installed in $HOME/dafoam/packages/miniconda/lib/python3.8/site-packages/

But still, it is not able to register it

Installing collected packages: dafoam
  Attempting uninstall: dafoam
    Found existing installation: dafoam 3.1.0
    Uninstalling dafoam-3.1.0:
      Successfully uninstalled dafoam-3.1.0
  Running setup.py develop for dafoam
Successfully installed dafoam-3.1.0

I get this message after i do pip install -e ..

Not sure why it is not removing the dafoam installation

[friedenhe]

Can you try to run pip install . without the -e flag? Removing the DASimpleFoam from the registry and still being able to use it indicates that your custom pyDAFoam.py is not copied to the right place. Another thing you can try is to run python then run import dafoam then run print(dafoam.__path__), you can see where the DAFoam repo is installed.

[uttamcadambi07]

Apologies for missing out on this but I did what you said and here is the output

/home/uttamcadambi/dafoam_v2/packages/miniconda3/lib/python3.8/site-packages/dafoam

Does this mean that it is being copied to the right place?

Also I must mention that I have two versions of DAFoam existing simultaneusly on my machine. Here is the loadDAFoam.sh file

#!/bin/bash
# DAFoam root path
export DAFOAM_ROOT_PATH=$HOME/dafoam
export DAFOAM_ROOT_PATH_ALT=$HOME/dafoam_v2
# OpenFOAM-v1812
source $DAFOAM_ROOT_PATH_ALT/OpenFOAM/OpenFOAM-v1812/etc/bashrc
export LD_LIBRARY_PATH=$DAFOAM_ROOT_PATH_ALT/OpenFOAM/sharedLibs:$LD_LIBRARY_PATH
export PATH=$DAFOAM_ROOT_PATH_ALT/OpenFOAM/sharedBins:$PATH
# Miniconda3
export PATH=$DAFOAM_ROOT_PATH_ALT/packages/miniconda3/bin:$PATH
export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:$DAFOAM_ROOT_PATH_ALT/packages/miniconda3/lib
export PYTHONUSERBASE=no-local-libs
# OpenMPI-3.1.6
export MPI_INSTALL_DIR=$DAFOAM_ROOT_PATH_ALT/packages/openmpi-3.1.6/opt-gfortran
export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:$MPI_INSTALL_DIR/lib
export PATH=$MPI_INSTALL_DIR/bin:$PATH
# Petsc-3.14.6
export PETSC_DIR=$DAFOAM_ROOT_PATH_ALT/packages/petsc-3.14.6
export PETSC_ARCH=real-opt
export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:$PETSC_DIR/$PETSC_ARCH/lib
export PETSC_LIB=$PETSC_DIR/$PETSC_ARCH/lib
# CGNS-4.1.2
export CGNS_HOME=$DAFOAM_ROOT_PATH_ALT/packages/CGNS-4.1.2/opt-gfortran
export PATH=$PATH:$CGNS_HOME/bin
export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:$CGNS_HOME/lib

[friedenhe]

Not sure what caused this, but one thing you can test is to use a docker image and then directly register your solver to /home/dafoamuser/dafoam/packages/miniconda3/lib/python3.8/site-packages/dafoam/pyDAFoam.py. This approach should work. Then, you can gradually change the above to your setup and see which step has problems.

[uttamcadambi07]

In the end, this was fixed if I just manually deleted the dafoam compiled libraries from the site-packages folder in miniconda. Thanks for your help.