Macros for creating fvPatchField types. More...

Include dependency graph for fvPatchFieldMacros.H:

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

Macros
#define	addToPatchFieldRunTimeSelection(PatchTypeField, typePatchTypeField)
#define	addRemovableToPatchFieldRunTimeSelection(PatchTypeField, typePatchTypeField)
#define	makePatchTypeField(PatchTypeField, typePatchTypeField)
	Define a concrete fvPatchField type and add to run-time tables Example, (fvPatchScalarField, calculatedFvPatchScalarField).
#define	makeRemovablePatchTypeField(PatchTypeField, typePatchTypeField)
#define	makePatchFieldTypeName(fieldType, bcType)
	Define a fvPatchField type for a specific field type Example, (scalar, calculated).
#define	addPatchFieldTypeRunTime(fieldType, bcType)
	Add runTime selection for fvPatchField type of a specific field type Example, (scalar, calculated).
#define	makePatchFieldType(fieldType, bcType)
#define	makePatchTypeFieldTypedef(fieldType, bcType)
	Declare a typedef for a fvPatchField. Example, (scalar, calculated).
#define	makePatchFields(bcType)
	For all standard field types: define a faPatchField type and add to run-time tables.
#define	makePatchFieldTypeNames(bcType)
	For all standard field types: define a faPatchField type. Example, (calculated).
#define	makePatchTypeFieldTypedefs(bcType)
	For all standard field types: define typedefs for the faPatchField Example, (calculated).
#define	makeTemplatePatchTypeField(fldType, bcType)

Detailed Description

Macros for creating fvPatchField types.

Original source file fvPatchFieldMacros.H

Definition in file fvPatchFieldMacros.H.

Macro Definition Documentation

◆ addToPatchFieldRunTimeSelection

#define addToPatchFieldRunTimeSelection	(		PatchTypeField,
			typePatchTypeField )

Value:

addToRunTimeSelectionTable                                                \
(                                                                         \
    PatchTypeField,                                                       \
    typePatchTypeField,                                                   \
    patch                                                                 \
);                                                                        \
addToRunTimeSelectionTable                                                \
(                                                                         \
    PatchTypeField,                                                       \
    typePatchTypeField,                                                   \
    patchMapper                                                           \
);                                                                        \
addToRunTimeSelectionTable                                                \
(                                                                         \
    PatchTypeField,                                                       \
    typePatchTypeField,                                                   \
    dictionary                                                            \
);

Definition at line 36 of file fvPatchFieldMacros.H.

◆ addRemovableToPatchFieldRunTimeSelection

#define addRemovableToPatchFieldRunTimeSelection	(		PatchTypeField,
			typePatchTypeField )

Value:

                                                                          \
addRemovableToRunTimeSelectionTable                                       \
(                                                                         \
    PatchTypeField,                                                       \
    typePatchTypeField,                                                   \
    patch                                                                 \
);                                                                        \
addRemovableToRunTimeSelectionTable                                       \
(                                                                         \
    PatchTypeField,                                                       \
    typePatchTypeField,                                                   \
    patchMapper                                                           \
);                                                                        \
addRemovableToRunTimeSelectionTable                                       \
(                                                                         \
    PatchTypeField,                                                       \
    typePatchTypeField,                                                   \
    dictionary                                                            \
);

Definition at line 59 of file fvPatchFieldMacros.H.

◆ makePatchTypeField

#define makePatchTypeField	(		PatchTypeField,
			typePatchTypeField )

Value:

                                                                          \
defineTypeNameAndDebug(typePatchTypeField, 0);                            \
addToPatchFieldRunTimeSelection(PatchTypeField, typePatchTypeField);

Define a concrete fvPatchField type and add to run-time tables Example, (fvPatchScalarField, calculatedFvPatchScalarField).

Definition at line 89 of file fvPatchFieldMacros.H.

◆ makeRemovablePatchTypeField

#define makeRemovablePatchTypeField	(		PatchTypeField,
			typePatchTypeField )

Value:

defineTypeNameAndDebug(typePatchTypeField, 0); \

addRemovableToPatchFieldRunTimeSelection(PatchTypeField, typePatchTypeField)

defineTypeNameAndDebug

#define defineTypeNameAndDebug(Type, DebugSwitch)

Define the typeName and debug information.

Definition className.H:142

Definition at line 95 of file fvPatchFieldMacros.H.

◆ makePatchFieldTypeName

#define makePatchFieldTypeName	(		fieldType,
			bcType )

Value:

defineNamedTemplateTypeNameAndDebug                                       \
(                                                                         \
    CAT4(bcType, FvPatch, CAPITALIZE(fieldType), Field),                  \
    0                                                                     \
);

Define a fvPatchField type for a specific field type Example, (scalar, calculated).

Definition at line 104 of file fvPatchFieldMacros.H.

◆ addPatchFieldTypeRunTime

#define addPatchFieldTypeRunTime	(		fieldType,
			bcType )

Value:

addToPatchFieldRunTimeSelection                                           \
(                                                                         \
    CAT3(fvPatch, CAPITALIZE(fieldType), Field),                          \
    CAT4(bcType, FvPatch, CAPITALIZE(fieldType), Field)                   \
);

Add runTime selection for fvPatchField type of a specific field type Example, (scalar, calculated).

Definition at line 115 of file fvPatchFieldMacros.H.

◆ makePatchFieldType

#define makePatchFieldType	(		fieldType,
			bcType )

Value:

makePatchFieldTypeName(fieldType, bcType) \

addPatchFieldTypeRunTime(fieldType, bcType)

makePatchFieldTypeName

#define makePatchFieldTypeName(fieldType, bcType)

Define a fvPatchField type for a specific field type Example, (scalar, calculated).

Definition fvPatchFieldMacros.H:104

Definition at line 123 of file fvPatchFieldMacros.H.

◆ makePatchTypeFieldTypedef

#define makePatchTypeFieldTypedef	(		fieldType,
			bcType )

Value:

typedef                                                                   \
    bcType##FvPatchField<fieldType>                                       \
    CAT4(bcType, FvPatch, CAPITALIZE(fieldType), Field);

Declare a typedef for a fvPatchField. Example, (scalar, calculated).

Definition at line 130 of file fvPatchFieldMacros.H.

◆ makePatchFields

#define makePatchFields ( bcType )

Value:

                                                                          \
makePatchFieldType(scalar, bcType);                                       \
makePatchFieldType(vector, bcType);                                       \
makePatchFieldType(sphericalTensor, bcType);                              \
makePatchFieldType(symmTensor, bcType);                                   \
makePatchFieldType(tensor, bcType);

For all standard field types: define a faPatchField type and add to run-time tables.

Definition at line 142 of file fvPatchFieldMacros.H.

◆ makePatchFieldTypeNames

#define makePatchFieldTypeNames ( bcType )

Value:

                                                                          \
makePatchFieldTypeName(scalar, bcType);                                   \
makePatchFieldTypeName(vector, bcType);                                   \
makePatchFieldTypeName(sphericalTensor, bcType);                          \
makePatchFieldTypeName(symmTensor, bcType);                               \
makePatchFieldTypeName(tensor, bcType);

For all standard field types: define a faPatchField type. Example, (calculated).

Definition at line 155 of file fvPatchFieldMacros.H.

◆ makePatchTypeFieldTypedefs

#define makePatchTypeFieldTypedefs ( bcType )

Value:

                                                                          \
makePatchTypeFieldTypedef(scalar, bcType);                                \
makePatchTypeFieldTypedef(vector, bcType);                                \
makePatchTypeFieldTypedef(sphericalTensor, bcType);                       \
makePatchTypeFieldTypedef(symmTensor, bcType);                            \
makePatchTypeFieldTypedef(tensor, bcType);

For all standard field types: define typedefs for the faPatchField Example, (calculated).

Definition at line 168 of file fvPatchFieldMacros.H.

◆ makeTemplatePatchTypeField

#define makeTemplatePatchTypeField	(		fldType,
			bcType )

Value:

makePatchFieldType(fldType, bcType)

makePatchFieldType

#define makePatchFieldType(fieldType, bcType)

Definition fvPatchFieldMacros.H:123

Definition at line 181 of file fvPatchFieldMacros.H.