CubicDual

class CubicDual(*args, **kwargs)[source]

Bases: openpnm.network.GenericNetwork.GenericNetwork

Body centered cubic lattice plus face centered nodes on the surfaces

This network is essentially a ‘bcc’ lattice, except that the seconary network (body-centered pores) has pores on each face of the domain, which breaks the body-centric arranagement. This allows boundary conditions to be applied to the seconary network for transport simuations.

Parameters
  • shape (list of ints) – The size and shape of the primary cubic network in terms of the number of pores in each direction. Secondary nodes will be added at centers of each unit cell.

  • spacing (list of floats) – The distance between pores of the primary network in each of the principal directions

  • label_1 (string) – The label to apply to the primary cubic lattices, which defaults to ‘primary’

  • label_2 (string) – The label to apply to the secondary cubic lattices, which defaults to ‘seconary’

  • project (OpenPNM Project object (optional)) – If not provided one will be generated and the network will be assigned to it. It can be retrieved from net.project.

  • name (string) – An optional name for the object to help identify it. If not given, one will be generated.

See also

Bravais

Examples

>>> import openpnm as op
>>> import matplotlib.pyplot as plt
>>> pn = op.network.CubicDual(shape=[3, 3, 3])
>>> pn.num_pores('pore.primary')  # Normal cubic network is present
27
>>> pn.Np  # But more pores are present from seconary network
59

And it can be plotted for quick visualization using:

>>> fig, ax = plt.subplots()
>>> _ = op.topotools.plot_connections(network=pn,
...                                   throats=pn.throats('primary'),
...                                   color='b', ax=ax)
>>> _ = op.topotools.plot_connections(network=pn,
...                                   throats=pn.throats('secondary'),
...                                   color='r', ax=ax)
>>> _ = op.topotools.plot_coordinates(network=pn, c='r', s=75, ax=ax)
../../_images/cubic_dual_network.png

For larger networks and more control over presentation use Paraview.

add_boundary_pores(labels=['top', 'bottom', 'front', 'back', 'left', 'right'], spacing=None)[source]

Add boundary pores to the specified faces of the network

Pores are offset from the faces by 1/2 of the given spacing, such that they lie directly on the boundaries.

Parameters
  • labels (string or list of strings) – The labels indicating the pores defining each face where boundary pores are to be added (e.g. ‘left’ or [‘left’, ‘right’])

  • spacing (scalar or array_like) – The spacing of the network (e.g. [1, 1, 1]). This must be given since it can be quite difficult to infer from the network, for instance if boundary pores have already added to other faces.