SurfaceChemistryMixin#

class ansys.chemkin.core.surface_chemistry.SurfaceChemistryMixin#

Surface chemistry related methods for the Chemistry class.

Overview#

set_surface_chemistry

Set up the surface chemistry data.

no_surface_mechanism_declaration

Inform users the Chemistry Set does not have surface chemistry.

get_material_index

Get the surface material index.

number_materials

Get the number of surface materials.

max_number_phases

Get the maximum number of phases.

max_number_sites

Get the maximum number of surface site species.

max_number_bulks

Get the maximum number of surface bulk species.

max_total_number_species

Get the maximum number of all species.

max_number_surface_reactions

Get the maximum number of surface reactions.

max_total_number_reactions

Get the maximum number of gas and surface reactions.

material_names

Get list of surface material names.

Import detail#

from ansys.chemkin.core.surface_chemistry import SurfaceChemistryMixin

Property detail#

property SurfaceChemistryMixin.number_materials: int#

Get the number of surface materials.

property SurfaceChemistryMixin.max_number_phases: int#

Get the maximum number of phases.

property SurfaceChemistryMixin.max_number_sites: int#

Get the maximum number of surface site species.

property SurfaceChemistryMixin.max_number_bulks: int#

Get the maximum number of surface bulk species.

property SurfaceChemistryMixin.max_total_number_species: int#

Get the maximum number of all species.

property SurfaceChemistryMixin.max_number_surface_reactions: int#

Get the maximum number of surface reactions.

property SurfaceChemistryMixin.max_total_number_reactions: int#

Get the maximum number of gas and surface reactions.

property SurfaceChemistryMixin.material_names: list[str]#

Get list of surface material names.

Method detail#

SurfaceChemistryMixin.set_surface_chemistry()#

Set up the surface chemistry data.

SurfaceChemistryMixin.no_surface_mechanism_declaration()#

Inform users the Chemistry Set does not have surface chemistry.

SurfaceChemistryMixin.get_material_index(mat_name: str) int#

Get the surface material index.