Mesh IO

[rowanc1]

From @rowanc1 on January 28, 2016 22:16

I would propose the file structure be replaced:

#----- replace ------
Utils.readUBCTensorMesh('myMesh.msh')
#----- with ------
M = SimPEG.Mesh.TensorMesh.readUBC('myMesh.msh')
v  = M.readModelUBC('model.dat')

This works well with the various types of meshes as well.

M.writeUBC('myNewMesh.msh')
M.writeModelUBC('myModel.dat', v)

I think that would clean up the syntax a bit, and allow these IO formats to live in the correct mesh file, but be used the same.

Similar:
writeVTK

Copied from original issue: simpeg/simpeg#212

[rowanc1]

@grosenkj the VTK IO depends on vtk libs? I will try to update travis and merge in those from treeMeshCounting.

[rowanc1]

From @grosenkj on January 28, 2016 23:40

I like this, makes sense.

We should maybe consider having:

M.writeUBC('myNewMesh.msh',model=None)

when model isn't given it just writes the mesh. Model should be a dict of {'model.dat':v}. Same would go for writeVTK.

What do you think?

[rowanc1]

From @grosenkj on January 28, 2016 23:43

Yes, vtkIO depends on VTK.

Awesome...

[rowanc1]

I quite like that.
I would propose a wrapper function:

def writeModelUBC(self):
    pass

@meshWriter(writeModelUBC)
def writeFORMAT(self, meshName):
    pass

Where the meshWriter:

def meshWriter(modelWriter):
    def meshWrapper(func):
        @wraps(func)
        def wrapper(self, meshName, models=None):
            func(self, meshName)
            if models is None: return
            assert type(models) is dict, 'models must be a dict'
            for key in models:
                assert type(key) is str, 'The dict key is a file name'
                modelWriter(self, key, models[key])
        return wrapper
    return meshWrapper

[rowanc1]

Decided to not go with the meshWriter wrapper.

[rowanc1]

@grosenkj wants the feature of utils depreciated:

Please put this back in the Utils class.

[rowanc1]

readUBCocTreeFiles(meshFile,modelFiles=None)
readUBCTensorMesh(fileName)
readUBCTensorModel(fileName, mesh)
writeUBCTensorMesh(fileName, mesh)
writeUBCTensorModel(fileName, mesh, model)
writeUBCocTreeFiles(fileName,mesh,modelDict=None)
readUBCocTreeFiles(meshFile,modelFiles=None)
readVTRFile(fileName)
writeVTRFile(fileName,mesh,model=None)
writeVTUFile(fileName,ocTreeMesh,modelDict=None)
simpegOcTree2vtuObj(simpegOcTreeMesh,modelDict=None)

[rowanc1]

From @lheagy on March 23, 2016 20:14

did this close with #265 ?

[rowanc1]

negative.