field_catalog.h File Reference

Authoritative identities and storage metadata for persistent Eulerian fields. More...

#include <stddef.h>
#include "variables.h"

Include dependency graph for field_catalog.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	FieldDimension
	Physical dimension as exponents of the reference length, velocity, and density. More...
struct	FieldDescriptor
	Immutable metadata for one field identity. More...
struct	FieldView
	Non-owning runtime objects resolved for one field and UserCtx. More...

Macros
#define	FIELD_DIM_DIMENSIONLESS   {FIELD_DIMENSION_FIXED, 0, 0, 0}
#define	FIELD_DIM_LENGTH   {FIELD_DIMENSION_FIXED, 1, 0, 0}
#define	FIELD_DIM_AREA   {FIELD_DIMENSION_FIXED, 2, 0, 0}
#define	FIELD_DIM_INVERSE_VOLUME   {FIELD_DIMENSION_FIXED, -3, 0, 0}
#define	FIELD_DIM_TIME   {FIELD_DIMENSION_FIXED, 1, -1, 0}
#define	FIELD_DIM_VELOCITY   {FIELD_DIMENSION_FIXED, 0, 1, 0}
#define	FIELD_DIM_VOLUME_FLUX   {FIELD_DIMENSION_FIXED, 2, 1, 0}
#define	FIELD_DIM_DIFFUSIVITY   {FIELD_DIMENSION_FIXED, 1, 1, 0}
#define	FIELD_DIM_PRESSURE   {FIELD_DIMENSION_FIXED, 0, 2, 1}
#define	FIELD_DIM_VELOCITY_SQUARED   {FIELD_DIMENSION_FIXED, 0, 2, 0}
#define	FIELD_DIM_INVERSE_TIME_SQUARED   {FIELD_DIMENSION_FIXED, -2, 2, 0}
#define	FIELD_DIM_NOT_A_QUANTITY   {FIELD_DIMENSION_NOT_A_QUANTITY, 0, 0, 0}
#define	FIELD_DIM_FROM_SOURCE   {FIELD_DIMENSION_FROM_SOURCE, 0, 0, 0}

Enumerations
enum	FieldId {   FIELD_ID_INVALID = -1 , FIELD_ID_COORDINATES = 0 , FIELD_ID_UCAT , FIELD_ID_UCONT ,   FIELD_ID_UCONT_O , FIELD_ID_UCONT_RM1 , FIELD_ID_P , FIELD_ID_NU_T ,   FIELD_ID_CS , FIELD_ID_U_TAU , FIELD_ID_WALL_STRESS , FIELD_ID_INFLOW_FLUCTUATION ,   FIELD_ID_DIFFUSIVITY , FIELD_ID_DIFFUSIVITY_GRADIENT , FIELD_ID_CSI , FIELD_ID_ETA ,   FIELD_ID_ZET , FIELD_ID_NVERT , FIELD_ID_AJ , FIELD_ID_CENT ,   FIELD_ID_CENTX , FIELD_ID_CENTY , FIELD_ID_CENTZ , FIELD_ID_ICSI ,   FIELD_ID_IETA , FIELD_ID_IZET , FIELD_ID_JCSI , FIELD_ID_JETA ,   FIELD_ID_JZET , FIELD_ID_KCSI , FIELD_ID_KETA , FIELD_ID_KZET ,   FIELD_ID_IAJ , FIELD_ID_JAJ , FIELD_ID_KAJ , FIELD_ID_PHI ,   FIELD_ID_PSI , FIELD_ID_NVERT_O , FIELD_ID_PARTICLE_COUNT , FIELD_ID_CELL_SCALAR_AT_CORNER ,   FIELD_ID_CELL_VECTOR_AT_CORNER , FIELD_ID_POST_SCALAR , FIELD_ID_POST_VECTOR , FIELD_ID_QCRIT ,   FIELD_ID_PLANE_NORMAL_I , FIELD_ID_PLANE_NORMAL_J , FIELD_ID_PLANE_NORMAL_K , FIELD_ID_PLANE_CENTROID_I ,   FIELD_ID_PLANE_CENTROID_J , FIELD_ID_PLANE_CENTROID_K , FIELD_ID_SEARCH_CELL_SIZE , FIELD_ID_DUAL_PLANE_NORMAL_I ,   FIELD_ID_DUAL_PLANE_NORMAL_J , FIELD_ID_DUAL_PLANE_NORMAL_K , FIELD_ID_DUAL_PLANE_CENTROID_I , FIELD_ID_DUAL_PLANE_CENTROID_J ,   FIELD_ID_DUAL_PLANE_CENTROID_K , FIELD_ID_COUNT }
	Compile-time identity for a catalogued Eulerian field. More...
enum	FieldLayout {   FIELD_LAYOUT_NODE_CENTERED = 0 , FIELD_LAYOUT_CELL_CENTERED , FIELD_LAYOUT_I_FACE , FIELD_LAYOUT_J_FACE ,   FIELD_LAYOUT_K_FACE , FIELD_LAYOUT_COMPONENT_STAGGERED }
	Logical storage topology of a field. More...
enum	FieldDMKind { FIELD_DM_DA = 0 , FIELD_DM_FDA }
	UserCtx DM family used to store a field. More...
enum	FieldSyncClass {   FIELD_SYNC_STANDARD = 0 , FIELD_SYNC_I_FACE , FIELD_SYNC_J_FACE , FIELD_SYNC_K_FACE ,   FIELD_SYNC_COMPONENT_STAGGERED }
	Extra repair required after the normal PETSc global-to-local scatter. More...
enum	FieldAvailability {   FIELD_AVAILABILITY_ALWAYS = 0u , FIELD_AVAILABILITY_FINEST_LEVEL = 1u << 0 , FIELD_AVAILABILITY_TURBULENCE = 1u << 1 , FIELD_AVAILABILITY_LES_DYNAMIC = 1u << 2 ,   FIELD_AVAILABILITY_PARTICLES = 1u << 4 , FIELD_AVAILABILITY_WALL_MODEL = 1u << 5 , FIELD_AVAILABILITY_INFLOW_FLUCTUATION = 1u << 6 }
	Conditions controlling when a field can have runtime storage. More...
enum	FieldCapabilities {   FIELD_CAPABILITY_NONE = 0u , FIELD_CAPABILITY_GHOST_UPDATE = 1u << 0 , FIELD_CAPABILITY_PERIODIC_CELL_SYNC = 1u << 1 , FIELD_CAPABILITY_PERIODIC_FACE_SYNC = 1u << 2 ,   FIELD_CAPABILITY_PERIODIC_STAGGERED_SYNC = 1u << 3 , FIELD_CAPABILITY_PERIODIC_GEOMETRY_SHIFT = 1u << 4 , FIELD_CAPABILITY_CHECKPOINT = 1u << 5 , FIELD_CAPABILITY_PARTICLE_SAMPLED = 1u << 6 }
	Operations supported by a catalog entry. More...
enum	FieldDimensionKind { FIELD_DIMENSION_FIXED = 0 , FIELD_DIMENSION_NOT_A_QUANTITY , FIELD_DIMENSION_FROM_SOURCE }
	How a field's physical dimension is known. More...

Functions
PetscErrorCode	FieldGetDescriptor (FieldId field_id, const FieldDescriptor **descriptor)
	Return immutable metadata for a valid field identifier.
PetscErrorCode	FieldIdFromName (const char *field_name, FieldId *field_id)
	Resolve a user-facing field name once into its typed identity.
PetscErrorCode	FieldTryIdFromName (const char *field_name, FieldId *field_id, PetscBool *found)
	Look a name up without treating an unknown name as an error.
PetscErrorCode	FieldDimensionReferenceScale (const ScalingCtx *scaling, FieldDimension dimension, PetscReal *scale)
	Return the factor that turns a solver value of one dimension into physical units.
PetscErrorCode	FieldDimensionLabel (FieldDimension dimension, char *label, size_t length)
	Write a printable form of a dimension, such as L^2 U or dimensionless.
const char *	FieldCanonicalName (FieldId field_id)
	Return the canonical printable name for an ID.
const char *	FieldLayoutName (FieldLayout layout)
	Return a stable printable label for a field layout.
PetscErrorCode	FieldGetView (UserCtx *user, FieldId field_id, FieldView *view)
	Resolve the existing DM and global/local vectors for one field.

Detailed Description

Authoritative identities and storage metadata for persistent Eulerian fields.

Field identifiers describe conceptual fields at compile time. They do not own, allocate, or modify PETSc objects. A FieldView resolves one identifier against an existing UserCtx after the normal setup lifecycle has created its DMs and vectors.

Definition in file field_catalog.h.

---

Data Structure Documentation

FieldDimension

struct FieldDimension

Physical dimension as exponents of the reference length, velocity, and density.

A solver value of dimension (a, b, c) becomes physical when multiplied by L_ref^a U_ref^b rho_ref^c. The launcher records input dimensions with the same triple (picurv_cli/core.py, INPUT_QUANTITIES), so input and output conversion use one vocabulary. See docs/pages/19_Nondimensionalization.md.

Definition at line 149 of file field_catalog.h.

Data Fields
FieldDimensionKind	kind
signed char	length
signed char	velocity
signed char	density

FieldDescriptor

struct FieldDescriptor

Immutable metadata for one field identity.

Definition at line 173 of file field_catalog.h.

Collaboration diagram for FieldDescriptor:

Data Fields
FieldId	id
const char *	canonical_name
const char *	alias_1
const char *	alias_2
PetscInt	dof
FieldDMKind	dm_kind
FieldLayout	layout
FieldSyncClass	sync_class
unsigned int	availability
unsigned int	capabilities
size_t	global_vec_offset
size_t	local_vec_offset
FieldDimension	dimension

FieldView

struct FieldView

Non-owning runtime objects resolved for one field and UserCtx.

Definition at line 190 of file field_catalog.h.

Collaboration diagram for FieldView:

Data Fields
const FieldDescriptor *	descriptor
DM	dm
Vec	global_vec
Vec	local_vec

Macro Definition Documentation

FIELD_DIM_DIMENSIONLESS

#define FIELD_DIM_DIMENSIONLESS   {FIELD_DIMENSION_FIXED, 0, 0, 0}

Definition at line 158 of file field_catalog.h.

FIELD_DIM_LENGTH

#define FIELD_DIM_LENGTH   {FIELD_DIMENSION_FIXED, 1, 0, 0}

Definition at line 159 of file field_catalog.h.

FIELD_DIM_AREA

#define FIELD_DIM_AREA   {FIELD_DIMENSION_FIXED, 2, 0, 0}

Definition at line 160 of file field_catalog.h.

FIELD_DIM_INVERSE_VOLUME

#define FIELD_DIM_INVERSE_VOLUME   {FIELD_DIMENSION_FIXED, -3, 0, 0}

Definition at line 161 of file field_catalog.h.

FIELD_DIM_TIME

#define FIELD_DIM_TIME   {FIELD_DIMENSION_FIXED, 1, -1, 0}

Definition at line 162 of file field_catalog.h.

FIELD_DIM_VELOCITY

#define FIELD_DIM_VELOCITY   {FIELD_DIMENSION_FIXED, 0, 1, 0}

Definition at line 163 of file field_catalog.h.

FIELD_DIM_VOLUME_FLUX

#define FIELD_DIM_VOLUME_FLUX   {FIELD_DIMENSION_FIXED, 2, 1, 0}

Definition at line 164 of file field_catalog.h.

FIELD_DIM_DIFFUSIVITY

#define FIELD_DIM_DIFFUSIVITY   {FIELD_DIMENSION_FIXED, 1, 1, 0}

Definition at line 165 of file field_catalog.h.

FIELD_DIM_PRESSURE

#define FIELD_DIM_PRESSURE   {FIELD_DIMENSION_FIXED, 0, 2, 1}

Definition at line 166 of file field_catalog.h.

FIELD_DIM_VELOCITY_SQUARED

#define FIELD_DIM_VELOCITY_SQUARED   {FIELD_DIMENSION_FIXED, 0, 2, 0}

Definition at line 167 of file field_catalog.h.

FIELD_DIM_INVERSE_TIME_SQUARED

#define FIELD_DIM_INVERSE_TIME_SQUARED   {FIELD_DIMENSION_FIXED, -2, 2, 0}

Definition at line 168 of file field_catalog.h.

FIELD_DIM_NOT_A_QUANTITY

#define FIELD_DIM_NOT_A_QUANTITY   {FIELD_DIMENSION_NOT_A_QUANTITY, 0, 0, 0}

Definition at line 169 of file field_catalog.h.

FIELD_DIM_FROM_SOURCE

#define FIELD_DIM_FROM_SOURCE   {FIELD_DIMENSION_FROM_SOURCE, 0, 0, 0}

Definition at line 170 of file field_catalog.h.

Enumeration Type Documentation

FieldId

enum FieldId

Compile-time identity for a catalogued Eulerian field.

Enumerator
FIELD_ID_INVALID
FIELD_ID_COORDINATES
FIELD_ID_UCAT
FIELD_ID_UCONT
FIELD_ID_UCONT_O
FIELD_ID_UCONT_RM1
FIELD_ID_P
FIELD_ID_NU_T
FIELD_ID_CS
FIELD_ID_U_TAU
FIELD_ID_WALL_STRESS
FIELD_ID_INFLOW_FLUCTUATION
FIELD_ID_DIFFUSIVITY
FIELD_ID_DIFFUSIVITY_GRADIENT
FIELD_ID_CSI
FIELD_ID_ETA
FIELD_ID_ZET
FIELD_ID_NVERT
FIELD_ID_AJ
FIELD_ID_CENT
FIELD_ID_CENTX
FIELD_ID_CENTY
FIELD_ID_CENTZ
FIELD_ID_ICSI
FIELD_ID_IETA
FIELD_ID_IZET
FIELD_ID_JCSI
FIELD_ID_JETA
FIELD_ID_JZET
FIELD_ID_KCSI
FIELD_ID_KETA
FIELD_ID_KZET
FIELD_ID_IAJ
FIELD_ID_JAJ
FIELD_ID_KAJ
FIELD_ID_PHI
FIELD_ID_PSI
FIELD_ID_NVERT_O
FIELD_ID_PARTICLE_COUNT
FIELD_ID_CELL_SCALAR_AT_CORNER
FIELD_ID_CELL_VECTOR_AT_CORNER
FIELD_ID_POST_SCALAR
FIELD_ID_POST_VECTOR
FIELD_ID_QCRIT
FIELD_ID_PLANE_NORMAL_I
FIELD_ID_PLANE_NORMAL_J
FIELD_ID_PLANE_NORMAL_K
FIELD_ID_PLANE_CENTROID_I
FIELD_ID_PLANE_CENTROID_J
FIELD_ID_PLANE_CENTROID_K
FIELD_ID_SEARCH_CELL_SIZE
FIELD_ID_DUAL_PLANE_NORMAL_I
FIELD_ID_DUAL_PLANE_NORMAL_J
FIELD_ID_DUAL_PLANE_NORMAL_K
FIELD_ID_DUAL_PLANE_CENTROID_I
FIELD_ID_DUAL_PLANE_CENTROID_J
FIELD_ID_DUAL_PLANE_CENTROID_K
FIELD_ID_COUNT

Definition at line 23 of file field_catalog.h.

             {
    FIELD_ID_INVALID = -1,
    FIELD_ID_COORDINATES = 0,
    FIELD_ID_UCAT,
    FIELD_ID_UCONT,
    FIELD_ID_UCONT_O,
    FIELD_ID_UCONT_RM1,
    FIELD_ID_P,
    FIELD_ID_NU_T,
    FIELD_ID_CS,
    FIELD_ID_U_TAU,
    FIELD_ID_WALL_STRESS,
    FIELD_ID_INFLOW_FLUCTUATION,
    FIELD_ID_DIFFUSIVITY,
    FIELD_ID_DIFFUSIVITY_GRADIENT,
    FIELD_ID_CSI,
    FIELD_ID_ETA,
    FIELD_ID_ZET,
    FIELD_ID_NVERT,
    FIELD_ID_AJ,
    FIELD_ID_CENT,
    FIELD_ID_CENTX,
    FIELD_ID_CENTY,
    FIELD_ID_CENTZ,
    FIELD_ID_ICSI,
    FIELD_ID_IETA,
    FIELD_ID_IZET,
    FIELD_ID_JCSI,
    FIELD_ID_JETA,
    FIELD_ID_JZET,
    FIELD_ID_KCSI,
    FIELD_ID_KETA,
    FIELD_ID_KZET,
    FIELD_ID_IAJ,
    FIELD_ID_JAJ,
    FIELD_ID_KAJ,
    FIELD_ID_PHI,
    FIELD_ID_PSI,
    FIELD_ID_NVERT_O,
    FIELD_ID_PARTICLE_COUNT,
    FIELD_ID_CELL_SCALAR_AT_CORNER,
    FIELD_ID_CELL_VECTOR_AT_CORNER,
    FIELD_ID_POST_SCALAR,
    FIELD_ID_POST_VECTOR,
    FIELD_ID_QCRIT,
    FIELD_ID_PLANE_NORMAL_I,
    FIELD_ID_PLANE_NORMAL_J,
    FIELD_ID_PLANE_NORMAL_K,
    FIELD_ID_PLANE_CENTROID_I,
    FIELD_ID_PLANE_CENTROID_J,
    FIELD_ID_PLANE_CENTROID_K,
    FIELD_ID_SEARCH_CELL_SIZE,
    FIELD_ID_DUAL_PLANE_NORMAL_I,
    FIELD_ID_DUAL_PLANE_NORMAL_J,
    FIELD_ID_DUAL_PLANE_NORMAL_K,
    FIELD_ID_DUAL_PLANE_CENTROID_I,
    FIELD_ID_DUAL_PLANE_CENTROID_J,
    FIELD_ID_DUAL_PLANE_CENTROID_K,
    FIELD_ID_COUNT
} FieldId;

FieldLayout

enum FieldLayout

Logical storage topology of a field.

Enumerator
FIELD_LAYOUT_NODE_CENTERED
FIELD_LAYOUT_CELL_CENTERED
FIELD_LAYOUT_I_FACE
FIELD_LAYOUT_J_FACE
FIELD_LAYOUT_K_FACE
FIELD_LAYOUT_COMPONENT_STAGGERED

Definition at line 85 of file field_catalog.h.

             {
    FIELD_LAYOUT_NODE_CENTERED = 0,
    FIELD_LAYOUT_CELL_CENTERED,
    FIELD_LAYOUT_I_FACE,
    FIELD_LAYOUT_J_FACE,
    FIELD_LAYOUT_K_FACE,
    FIELD_LAYOUT_COMPONENT_STAGGERED
} FieldLayout;

FieldDMKind

enum FieldDMKind

UserCtx DM family used to store a field.

Enumerator
FIELD_DM_DA
FIELD_DM_FDA

Definition at line 95 of file field_catalog.h.

             {
    FIELD_DM_DA = 0,
    FIELD_DM_FDA
} FieldDMKind;

FieldSyncClass

enum FieldSyncClass

Extra repair required after the normal PETSc global-to-local scatter.

Enumerator
FIELD_SYNC_STANDARD
FIELD_SYNC_I_FACE
FIELD_SYNC_J_FACE
FIELD_SYNC_K_FACE
FIELD_SYNC_COMPONENT_STAGGERED

Definition at line 101 of file field_catalog.h.

             {
    FIELD_SYNC_STANDARD = 0,
    FIELD_SYNC_I_FACE,
    FIELD_SYNC_J_FACE,
    FIELD_SYNC_K_FACE,
    FIELD_SYNC_COMPONENT_STAGGERED
} FieldSyncClass;

FieldAvailability

enum FieldAvailability

Conditions controlling when a field can have runtime storage.

Enumerator
FIELD_AVAILABILITY_ALWAYS
FIELD_AVAILABILITY_FINEST_LEVEL
FIELD_AVAILABILITY_TURBULENCE
FIELD_AVAILABILITY_LES_DYNAMIC
FIELD_AVAILABILITY_PARTICLES
FIELD_AVAILABILITY_WALL_MODEL
FIELD_AVAILABILITY_INFLOW_FLUCTUATION

Definition at line 110 of file field_catalog.h.

             {
    FIELD_AVAILABILITY_ALWAYS       = 0u,
    FIELD_AVAILABILITY_FINEST_LEVEL = 1u << 0,
    FIELD_AVAILABILITY_TURBULENCE   = 1u << 1,
    FIELD_AVAILABILITY_LES_DYNAMIC  = 1u << 2,
    FIELD_AVAILABILITY_PARTICLES    = 1u << 4,
    FIELD_AVAILABILITY_WALL_MODEL   = 1u << 5,
    FIELD_AVAILABILITY_INFLOW_FLUCTUATION = 1u << 6
} FieldAvailability;

FieldCapabilities

enum FieldCapabilities

Operations supported by a catalog entry.

Enumerator
FIELD_CAPABILITY_NONE
FIELD_CAPABILITY_GHOST_UPDATE
FIELD_CAPABILITY_PERIODIC_CELL_SYNC
FIELD_CAPABILITY_PERIODIC_FACE_SYNC
FIELD_CAPABILITY_PERIODIC_STAGGERED_SYNC
FIELD_CAPABILITY_PERIODIC_GEOMETRY_SHIFT
FIELD_CAPABILITY_CHECKPOINT
FIELD_CAPABILITY_PARTICLE_SAMPLED	Defined only where a cell holds particles; elsewhere the stored value is a placeholder, not a measurement, and statistics skip it.

Definition at line 121 of file field_catalog.h.

             {
    FIELD_CAPABILITY_NONE                      = 0u,
    FIELD_CAPABILITY_GHOST_UPDATE              = 1u << 0,
    FIELD_CAPABILITY_PERIODIC_CELL_SYNC        = 1u << 1,
    FIELD_CAPABILITY_PERIODIC_FACE_SYNC        = 1u << 2,
    FIELD_CAPABILITY_PERIODIC_STAGGERED_SYNC   = 1u << 3,
    FIELD_CAPABILITY_PERIODIC_GEOMETRY_SHIFT   = 1u << 4,
    FIELD_CAPABILITY_CHECKPOINT                = 1u << 5,
    /** Defined only where a cell holds particles; elsewhere the stored value is a
     *  placeholder, not a measurement, and statistics skip it. */
    FIELD_CAPABILITY_PARTICLE_SAMPLED          = 1u << 6
} FieldCapabilities;

FieldDimensionKind

enum FieldDimensionKind

How a field's physical dimension is known.

Enumerator
FIELD_DIMENSION_FIXED	The exponents are the field's dimension.
FIELD_DIMENSION_NOT_A_QUANTITY	Integer bookkeeping: identities, flags, ranks.
FIELD_DIMENSION_FROM_SOURCE	Staging storage: carries whatever was written into it.

Definition at line 135 of file field_catalog.h.

             {
    FIELD_DIMENSION_FIXED = 0,       /**< The exponents are the field's dimension. */
    FIELD_DIMENSION_NOT_A_QUANTITY,  /**< Integer bookkeeping: identities, flags, ranks. */
    FIELD_DIMENSION_FROM_SOURCE      /**< Staging storage: carries whatever was written into it. */
} FieldDimensionKind;

Function Documentation

FieldGetDescriptor()

PetscErrorCode FieldGetDescriptor	(	FieldId	field_id,
		const FieldDescriptor **	descriptor
	)

Return immutable metadata for a valid field identifier.

Parameters

[in]	field_id	Compile-time field identity.
[out]	descriptor	Catalog entry owned by the field-catalog module.

Returns

Zero on success; PETSc error for an invalid ID or null output.

Return immutable metadata for a valid field identifier.

Validates the enum range and the table's ID/index invariant before exposing the catalog-owned descriptor.

See also

FieldGetDescriptor()

Definition at line 285 of file field_catalog.c.

{
    PetscFunctionBeginUser;
    PROFILE_HELPER_BEGIN;
    PetscCheck(descriptor != NULL, PETSC_COMM_SELF, PETSC_ERR_ARG_NULL,
               "Field descriptor output cannot be NULL.");
    PetscCheck(field_id >= 0 && field_id < FIELD_ID_COUNT, PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE,
               "Invalid FieldId value %d.", (int)field_id);
    PetscCheck(gFieldCatalog[field_id].id == field_id, PETSC_COMM_SELF, PETSC_ERR_PLIB,
               "Field catalog entry %d is not initialized consistently.", (int)field_id);
 
    *descriptor = &gFieldCatalog[field_id];
    PROFILE_HELPER_END;
    PetscFunctionReturn(0);
}

Here is the caller graph for this function:

FieldIdFromName()

PetscErrorCode FieldIdFromName	(	const char *	field_name,
		FieldId *	field_id
	)

Resolve a user-facing field name once into its typed identity.

Parameters

[in]	field_name	Canonical name or registered alias.
[out]	field_id	Resolved field identity.

Returns

Zero on success; PETSc unknown-type error for an unregistered name.

Resolve a user-facing field name once into its typed identity.

Name comparison is intentionally confined to ingress; numerical consumers receive the resolved FieldId.

See also

FieldIdFromName()

Definition at line 307 of file field_catalog.c.

{
    PetscBool found = PETSC_FALSE;
 
    PetscFunctionBeginUser;
    PROFILE_FUNCTION_BEGIN;
    PetscCall(FieldTryIdFromName(field_name, field_id, &found));
    PetscCheck(found, PETSC_COMM_SELF, PETSC_ERR_ARG_UNKNOWN_TYPE,
               "Field name '%s' is not registered in the Eulerian field catalog.", field_name);
    PROFILE_FUNCTION_END;
    PetscFunctionReturn(0);
}

Here is the call graph for this function:

Here is the caller graph for this function:

FieldTryIdFromName()

PetscErrorCode FieldTryIdFromName	(	const char *	field_name,
		FieldId *	field_id,
		PetscBool *	found
	)

Look a name up without treating an unknown name as an error.

For callers that consult more than one catalog, such as a name that may be an Eulerian or a particle field.

Parameters

[in]	field_name	Canonical name or registered alias.
[out]	field_id	Resolved identity, or FIELD_ID_INVALID when not found.
[out]	found	Whether the name is registered.

Returns

Zero on success; PETSc error only for null arguments.

Look a name up without treating an unknown name as an error.

See also

FieldTryIdFromName()

Definition at line 324 of file field_catalog.c.

{
    PetscFunctionBeginUser;
    PROFILE_FUNCTION_BEGIN;
    PetscCheck(field_name != NULL, PETSC_COMM_SELF, PETSC_ERR_ARG_NULL,
               "Field name cannot be NULL.");
    PetscCheck(field_id != NULL && found != NULL, PETSC_COMM_SELF, PETSC_ERR_ARG_NULL,
               "FieldId and found outputs cannot be NULL.");
 
    *field_id = FIELD_ID_INVALID;
    *found = PETSC_FALSE;
    for (PetscInt index = 0; index < FIELD_ID_COUNT; ++index) {
        const FieldDescriptor *descriptor = &gFieldCatalog[index];
        PetscBool match = PETSC_FALSE;
 
        PetscCall(PetscStrcasecmp(field_name, descriptor->canonical_name, &match));
        if (!match && descriptor->alias_1) PetscCall(PetscStrcasecmp(field_name, descriptor->alias_1, &match));
        if (!match && descriptor->alias_2) PetscCall(PetscStrcasecmp(field_name, descriptor->alias_2, &match));
        if (match) {
            *field_id = descriptor->id;
            *found = PETSC_TRUE;
            break;
        }
    }
    PROFILE_FUNCTION_END;
    PetscFunctionReturn(0);
}

Here is the caller graph for this function:

FieldDimensionReferenceScale()

PetscErrorCode FieldDimensionReferenceScale	(	const ScalingCtx *	scaling,
		FieldDimension	dimension,
		PetscReal *	scale
	)

Return the factor that turns a solver value of one dimension into physical units.

Parameters

[in]	scaling	Reference scales of the run.
[in]	dimension	Dimension to scale.
[out]	scale	L_ref^a U_ref^b rho_ref^c for a fixed dimension (a, b, c).

Returns

Zero on success; PETSC_ERR_ARG_WRONGSTATE for a dimension that is not fixed, since bookkeeping and staging storage have no scale of their own.

Return the factor that turns a solver value of one dimension into physical units.

See also

FieldDimensionReferenceScale()

Definition at line 356 of file field_catalog.c.

{
    PetscFunctionBeginUser;
    PROFILE_FUNCTION_BEGIN;
    PetscCheck(scaling != NULL && scale != NULL, PETSC_COMM_SELF, PETSC_ERR_ARG_NULL,
               "Scaling context and scale output cannot be NULL.");
    PetscCheck(dimension.kind == FIELD_DIMENSION_FIXED, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONGSTATE,
               "Only a field with a fixed physical dimension has a reference scale.");
    *scale = PetscPowRealInt(scaling->L_ref, dimension.length) *
             PetscPowRealInt(scaling->U_ref, dimension.velocity) *
             PetscPowRealInt(scaling->rho_ref, dimension.density);
    PROFILE_FUNCTION_END;
    PetscFunctionReturn(0);
}

Here is the caller graph for this function:

FieldDimensionLabel()

PetscErrorCode FieldDimensionLabel	(	FieldDimension	dimension,
		char *	label,
		size_t	length
	)

Write a printable form of a dimension, such as L^2 U or dimensionless.

Parameters

[in]	dimension	Dimension to describe.
[out]	label	Destination buffer.
[in]	length	Buffer length.

Returns

Zero on success.

Write a printable form of a dimension, such as L^2 U or dimensionless.

See also

FieldDimensionLabel()

Definition at line 376 of file field_catalog.c.

{
    const char *symbols[3] = {"L", "U", "rho"};
    const int   exponents[3] = {dimension.length, dimension.velocity, dimension.density};
    size_t      used = 0;
 
    PetscFunctionBeginUser;
    PROFILE_FUNCTION_BEGIN;
    PetscCheck(label != NULL && length > 0, PETSC_COMM_SELF, PETSC_ERR_ARG_NULL,
               "Dimension label buffer cannot be NULL or empty.");
    label[0] = '\0';
    if (dimension.kind == FIELD_DIMENSION_NOT_A_QUANTITY) {
        PetscCall(PetscStrncpy(label, "not a physical quantity", length));
        PROFILE_FUNCTION_END;
        PetscFunctionReturn(0);
    }
    if (dimension.kind == FIELD_DIMENSION_FROM_SOURCE) {
        PetscCall(PetscStrncpy(label, "dimension of its source field", length));
        PROFILE_FUNCTION_END;
        PetscFunctionReturn(0);
    }
    for (int index = 0; index < 3; ++index) {
        if (!exponents[index]) continue;
        if (exponents[index] == 1) {
            PetscCall(PetscSNPrintf(label + used, length - used, "%s%s", used ? " " : "", symbols[index]));
        } else {
            PetscCall(PetscSNPrintf(label + used, length - used, "%s%s^%d", used ? " " : "",
                                    symbols[index], exponents[index]));
        }
        PetscCall(PetscStrlen(label, &used));
    }
    if (!used) PetscCall(PetscStrncpy(label, "dimensionless", length));
    PROFILE_FUNCTION_END;
    PetscFunctionReturn(0);
}

Here is the caller graph for this function:

FieldCanonicalName()

const char * FieldCanonicalName

(

FieldId

field_id

)

Return the canonical printable name for an ID.

Parameters

[in]

field_id

Field identity.

Returns

Canonical name, or "InvalidField" for an invalid ID.

Return the canonical printable name for an ID.

Invalid enum values return a non-null diagnostic sentinel string.

See also

FieldCanonicalName()

Definition at line 417 of file field_catalog.c.

{
    PROFILE_HELPER_BEGIN;
    const char *name = (field_id >= 0 && field_id < FIELD_ID_COUNT && gFieldCatalog[field_id].id == field_id)
                           ? gFieldCatalog[field_id].canonical_name : "InvalidField";
    PROFILE_HELPER_END;
    return name;
}

Here is the caller graph for this function:

FieldLayoutName()

const char * FieldLayoutName

(

FieldLayout

layout

)

Return a stable printable label for a field layout.

Parameters

[in]

layout

Layout enum to describe.

Returns

Catalog-owned label, or Invalid-Layout for an invalid enum.

Return a stable printable label for a field layout.

See also

FieldLayoutName()

Definition at line 430 of file field_catalog.c.

{
    PROFILE_HELPER_BEGIN;
    const char *name;
    switch (layout) {
        case FIELD_LAYOUT_NODE_CENTERED:       name = "Node-Centered"; break;
        case FIELD_LAYOUT_CELL_CENTERED:       name = "Cell-Centered"; break;
        case FIELD_LAYOUT_I_FACE:              name = "I-Face"; break;
        case FIELD_LAYOUT_J_FACE:              name = "J-Face"; break;
        case FIELD_LAYOUT_K_FACE:              name = "K-Face"; break;
        case FIELD_LAYOUT_COMPONENT_STAGGERED: name = "Component-Staggered"; break;
        default:                               name = "Invalid-Layout"; break;
    }
    PROFILE_HELPER_END;
    return name;
}

Here is the caller graph for this function:

FieldGetView()

PetscErrorCode FieldGetView	(	UserCtx *	user,
		FieldId	field_id,
		FieldView *	view
	)

Resolve the existing DM and global/local vectors for one field.

This function never creates storage. Optional fields whose setup conditions were not enabled retain valid descriptors but return PETSC_ERR_ARG_WRONGSTATE because their runtime vectors are absent.

Parameters

[in]	user	Existing per-grid context.
[in]	field_id	Field identity to resolve.
[out]	view	Non-owning runtime view.

Returns

Zero on success or a PETSc argument/state error.

Resolve the existing DM and global/local vectors for one field.

Resolves DM and Vec handles without allocating, referencing, or destroying PETSc storage.

See also

FieldGetView()

Definition at line 453 of file field_catalog.c.

{
    const FieldDescriptor *descriptor = NULL;
 
    PetscFunctionBeginUser;
    PROFILE_HELPER_BEGIN;
    PetscCheck(user != NULL, PETSC_COMM_SELF, PETSC_ERR_ARG_NULL,
               "UserCtx cannot be NULL when resolving a field view.");
    PetscCheck(view != NULL, PETSC_COMM_SELF, PETSC_ERR_ARG_NULL,
               "Field view output cannot be NULL.");
    PetscCall(FieldGetDescriptor(field_id, &descriptor));
 
    view->descriptor = descriptor;
    view->dm = NULL;
    view->global_vec = NULL;
    view->local_vec = NULL;
 
    switch (descriptor->dm_kind) {
        case FIELD_DM_DA:
            view->dm = user->da;
            break;
        case FIELD_DM_FDA:
            view->dm = user->fda;
            break;
        default:
            SETERRQ(PETSC_COMM_SELF, PETSC_ERR_PLIB,
                    "Field '%s' has an invalid DM selector.", descriptor->canonical_name);
    }
 
    view->global_vec = *(Vec *)((char *)user + descriptor->global_vec_offset);
    view->local_vec = *(Vec *)((char *)user + descriptor->local_vec_offset);
 
    PetscCheck(view->dm != NULL, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONGSTATE,
               "DM for field '%s' is unavailable in this UserCtx.", descriptor->canonical_name);
    PetscCheck(view->global_vec != NULL, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONGSTATE,
               "Global vector for field '%s' is unavailable in this UserCtx.", descriptor->canonical_name);
    PetscCheck(view->local_vec != NULL, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONGSTATE,
               "Local vector for field '%s' is unavailable in this UserCtx.", descriptor->canonical_name);
 
    PROFILE_HELPER_END;
    PetscFunctionReturn(0);
}

Here is the call graph for this function:

Here is the caller graph for this function: