Skip navigation links
(CGNS Documentation Home Page) (Steering Committee Charter) (Overview and Entry-Level Document) (A User's Guide to CGNS) (Mid-Level Library) (Standard Interface Data Structures) (SIDS File Mapping Manual) (CGIO User's Guide) (Parallel CGNS User's Guide) (ADF Implementation) (HDF5 Implementation) (Python Implementation) (CGNS Tools and Utilities)

(General Remarks) (File Operations) (Navigating a CGNS File) (Error Handling) (Structural Nodes) (Descriptors) (Physical Data) (Location and Position) (Auxiliary Data) (Grid Specification) (Solution Data) (Grid Connectivity) (Boundary Conditions) (Equation Specification) (Families) (Time-Dependent Data) (Links)

Families

Family Definition

Node: Family_t (SIDS, File Mapping)

Functions Modes
ier = cg_family_write(int fn, int B, char *FamilyName, int *Fam); - w m
ier = cg_nfamilies(int fn, int B, int *nfamilies); r - m
ier = cg_family_read(int fn, int B, int Fam, char *FamilyName,
      int *nFamBC, int *nGeo);
r - m
ier = cg_family_name_write(int fn, int B, int Fam, char *NodeName,
      char *FamilyName);
- w m
ier = cg_nfamily_names(int fn, int B, int Fam, int *nNames); r - m
ier = cg_family_name_read(int fn, int B, int Fam, int N,
      char *NodeName, char *FamilyName);
r - m
call cg_family_write_f(fn, B, FamilyName, Fam, ier) - w m
call cg_nfamilies_f(fn, B, nfamilies, ier) r - m
call cg_family_read_f(fn, B, Fam, FamilyName, nFamBC, nGeo, ier) r - m
call cg_family_name_write_f(fn, B, Fam, NodeName, FamilyName, ier) - w m
call cg_nfamily_names_f(fn, B, Fam, nNames, ier) r - m
call cg_family_name_read_f(fn, B, Fam, N, NodeName, FamilyName, ier) r - m

Input/Output

    fn   CGNS file index number.
B Base index number, where 1 ≤ Bnbases.
nfamilies Number of families in base B.
Fam Family index number, where 1 ≤ Famnfamilies.
FamilyName Name of the family.
NodeName Name of the FamilyName_t node. FamilyParent is used to refer to the parent family of the Family_t node.
nFamBC Number of boundary conditions for this family. This should be either 0 or 1.
nGeo Number of geometry references for this family.
nNames Number of FamilyName_t nodes for this family.
N Family name index number, where 1 ≤ NnNames.
ier Error status.

Geometry Reference

Node: GeometryReference_t (SIDS, File Mapping)

Functions Modes
ier = cg_geo_write(int fn, int B, int Fam, char *GeoName,
      char *FileName, char *CADSystem, int *G);
- w m
ier = cg_geo_read(int fn, int B, int Fam, int G, char *GeoName,
      char **FileName, char *CADSystem, int *nparts);
r - m
ier = cg_part_write(int fn, int B, int Fam, int G, char *PartName,
      int *P);
- w m
ier = cg_part_read(int fn, int B, int Fam, int G, int P,
      char *PartName);
r - m
call cg_geo_write_f(fn, B, Fam, GeoName, FileName, CADSystem, G,
     ier)
- w m
call cg_geo_read_f(fn, B, Fam, G, GeoName, FileName, CADSystem,
     nparts, ier)
r - m
call cg_part_write_f(fn, B, Fam, G, PartName, P, ier) - w m
call cg_part_read_f(fn, B, Fam, G, P, PartName, ier) r - m

Input/Output

    fn   CGNS file index number.
B Base index number, where 1 ≤ Bnbases.
Fam Family index number, where 1 ≤ Famnfamilies.
G Geometry reference index number, where 1 ≤ GnGeo.
P Geometry entity index number, where 1 ≤ Pnparts.
GeoName Name of GeometryReference_t node.
FileName Name of geometry file.
CADSystem Geometry format.
nparts Number of geometry entities.
PartName Name of a geometry entity in the file FileName.
ier Error status.

Note that with cg_geo_read the memory for the filename character string, FileName, will be allocated by the Mid-Level Library. The application code is responsible for releasing this memory when it is no longer needed by calling cg_free(FileName).

Family Boundary Condition

Node: FamilyBC_t (SIDS, File Mapping)

Functions Modes
ier = cg_fambc_write(int fn, int B, int Fam, char *FamBCName,
      BCType_t BCType, int *BC);
- w m
ier = cg_fambc_read(int fn, int B, int Fam, int BC,
      char *FamBCName, BCType_t *BCType);
r - m
call cg_fambc_write_f(fn, B, Fam, FamBCName, BCType, BC, ier) - w m
call cg_fambc_read_f(fn, B, Fam, BC, FamBCName, BCType, ier) r - m

Input/Output

    fn   CGNS file index number.
B Base index number, where 1 ≤ Bnbases.
Fam Family index number, where 1 ≤ Famnfamilies.
BC Family boundary condition index number. This must be equal to 1.
FamBCName Name of the FamilyBC_t node.
BCType Boundary condition type for the family. See the eligible types for BCType_t in the Typedefs section.
ier Error status.

Family Name

Node: FamilyName_t (SIDS, File Mapping)

Functions Modes
ier = cg_famname_write(char *FamilyName); - w m
ier = cg_famname_read(char *FamilyName); r - m
ier = cg_multifam_write(char *NodeName, char *FamilyName); - w m
ier = cg_nmultifam(int *nNames); r - m
ier = cg_multifam_read(int N, char *NodeName, char *FamilyName); r - m
call cg_famname_write_f(FamilyName, ier) - w m
call cg_famname_read_f(FamilyName, ier) r - m
call cg_multifam_write_f(NodeName, FamilyName, ier) - w m
call cg_nmultifam_f(nNames, ier) r - m
call cg_multifam_read_f(N, NodeName, FamilyName, ier) r - m

Input/Output

    NodeName   Node name.
FamilyName Family name.
nNames Number of additional family names.
N Family name index number, where 1 ≤ NnNames.
ier Error status.

Note that the family name written cg_famname_write is stored in a FamilyName_t node named FamilyName as in previous versions. The additional family names written with cg_multifam_write are stored in AdditionalFamilyName_t nodes.