This boundary condition provides a jump condition, using the cyclic condition as a base. The jump is specified as a time-varying uniform value across the patch. More...

Inheritance diagram for uniformJumpFvPatchField< Type >:

[legend]

Collaboration diagram for uniformJumpFvPatchField< Type >:

[legend]

Public Member Functions
	TypeName ("uniformJump")
	Runtime type information. More...

	uniformJumpFvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &)
	Construct from patch and internal field. More...

	uniformJumpFvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const dictionary &)
	Construct from patch, internal field and dictionary. More...

	uniformJumpFvPatchField (const uniformJumpFvPatchField< Type > &, const fvPatch &, const DimensionedField< Type, volMesh > &, const fvPatchFieldMapper &)
	Construct by mapping given uniformJumpFvPatchField onto a. More...

	uniformJumpFvPatchField (const uniformJumpFvPatchField< Type > &)
	Construct as copy. More...

virtual tmp< fvPatchField< Type > >	clone () const
	Construct and return a clone. More...

	uniformJumpFvPatchField (const uniformJumpFvPatchField< Type > &, const DimensionedField< Type, volMesh > &)
	Construct as copy setting internal field reference. More...

virtual tmp< fvPatchField< Type > >	clone (const DimensionedField< Type, volMesh > &iF) const
	Construct and return a clone setting internal field reference. More...

virtual void	updateCoeffs ()
	Update the coefficients. More...

virtual void	write (Ostream &) const
	Write. More...

Public Member Functions inherited from fixedJumpFvPatchField< Type >
	TypeName ("fixedJump")
	Runtime type information. More...

	fixedJumpFvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &)
	Construct from patch and internal field. More...

	fixedJumpFvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const dictionary &)
	Construct from patch, internal field and dictionary. More...

	fixedJumpFvPatchField (const fixedJumpFvPatchField< Type > &, const fvPatch &, const DimensionedField< Type, volMesh > &, const fvPatchFieldMapper &)
	Construct by mapping given fixedJumpFvPatchField onto a. More...

	fixedJumpFvPatchField (const fixedJumpFvPatchField< Type > &)
	Construct as copy. More...

	fixedJumpFvPatchField (const fixedJumpFvPatchField< Type > &, const DimensionedField< Type, volMesh > &)
	Construct as copy setting internal field reference. More...

virtual tmp< Field< Type > >	jump () const
	Return the "jump" across the patch. More...

virtual void	autoMap (const fvPatchFieldMapper &)
	Map (and resize as needed) from self given a mapping object. More...

virtual void	rmap (const fvPatchField< Type > &, const labelList &)
	Reverse map the given fvPatchField onto this fvPatchField. More...

Public Member Functions inherited from jumpCyclicFvPatchField< Type >
	TypeName ("jumpCyclic")
	Runtime type information. More...

	jumpCyclicFvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &)
	Construct from patch and internal field. More...

	jumpCyclicFvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const dictionary &)
	Construct from patch, internal field and dictionary. More...

	jumpCyclicFvPatchField (const jumpCyclicFvPatchField< Type > &, const fvPatch &, const DimensionedField< Type, volMesh > &, const fvPatchFieldMapper &)
	Construct by mapping given jumpCyclicFvPatchField onto a new patch. More...

	jumpCyclicFvPatchField (const jumpCyclicFvPatchField< Type > &)
	Construct as copy. More...

	jumpCyclicFvPatchField (const jumpCyclicFvPatchField< Type > &, const DimensionedField< Type, volMesh > &)
	Construct as copy setting internal field reference. More...

virtual const word &	interfaceFieldType () const
	Return the interface type. More...

tmp< Field< Type > >	patchNeighbourField () const
	Return neighbour coupled given internal cell data. More...

virtual void	updateInterfaceMatrix (scalarField &result, const scalarField &psiInternal, const scalarField &coeffs, const direction cmpt, const Pstream::commsTypes commsType) const
	Update result field based on interface functionality. More...

virtual void	updateInterfaceMatrix (Field< Type > &, const Field< Type > &, const scalarField &, const Pstream::commsTypes commsType) const
	Update result field based on interface functionality. More...

template<>
void	updateInterfaceMatrix (scalarField &result, const scalarField &psiInternal, const scalarField &coeffs, const direction cmpt, const Pstream::commsTypes commsType) const
	Update result field based on interface functionality. More...

template<>
void	updateInterfaceMatrix (scalarField &result, const scalarField &psiInternal, const scalarField &coeffs, const direction cmpt, const Pstream::commsTypes) const
	Update result field based on interface functionality. More...

Public Member Functions inherited from cyclicFvPatchField< Type >
	TypeName (cyclicFvPatch::typeName_())
	Runtime type information. More...

	cyclicFvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &)
	Construct from patch and internal field. More...

	cyclicFvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const dictionary &)
	Construct from patch, internal field and dictionary. More...

	cyclicFvPatchField (const cyclicFvPatchField< Type > &, const fvPatch &, const DimensionedField< Type, volMesh > &, const fvPatchFieldMapper &)
	Construct by mapping given cyclicFvPatchField onto a new patch. More...

	cyclicFvPatchField (const cyclicFvPatchField< Type > &)
	Construct as copy. More...

	cyclicFvPatchField (const cyclicFvPatchField< Type > &, const DimensionedField< Type, volMesh > &)
	Construct as copy setting internal field reference. More...

const cyclicFvPatch &	cyclicPatch () const
	Return local reference cast into the cyclic patch. More...

const cyclicFvPatchField< Type > &	neighbourPatchField () const
	Return reference to neighbour patchField. More...

virtual bool	doTransform () const
	Does the patch field perform the transformation. More...

virtual const tensorField &	forwardT () const
	Return face transformation tensor. More...

virtual const tensorField &	reverseT () const
	Return neighbour-cell transformation tensor. More...

virtual int	rank () const
	Return rank of component for transform. More...

Public Member Functions inherited from cyclicLduInterfaceField
	TypeName ("cyclicLduInterfaceField")
	Runtime type information. More...

	cyclicLduInterfaceField ()
	Construct given coupled patch. More...

virtual	~cyclicLduInterfaceField ()
	Destructor. More...

template<class Type >
void	transformCoupleField (Field< Type > &f) const
	Transform given patch field. More...

void	transformCoupleField (scalarField &f, const direction cmpt) const
	Transform given patch component field. More...

Public Member Functions inherited from coupledFvPatchField< Type >
	TypeName (coupledFvPatch::typeName_())
	Runtime type information. More...

	coupledFvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &)
	Construct from patch and internal field. More...

	coupledFvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const Field< Type > &)
	Construct from patch and internal field and patch field. More...

	coupledFvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const dictionary &, const bool valueRequired=true)
	Construct from patch, internal field and dictionary. More...

	coupledFvPatchField (const coupledFvPatchField< Type > &, const fvPatch &, const DimensionedField< Type, volMesh > &, const fvPatchFieldMapper &)
	Construct by mapping the given coupledFvPatchField onto a new patch. More...

	coupledFvPatchField (const coupledFvPatchField< Type > &)
	Construct as copy. More...

	coupledFvPatchField (const coupledFvPatchField< Type > &, const DimensionedField< Type, volMesh > &)
	Construct as copy setting internal field reference. More...

virtual bool	coupled () const
	Return true if this patch field is derived from. More...

virtual tmp< Field< Type > >	snGrad (const scalarField &deltaCoeffs) const
	Return patch-normal gradient. More...

virtual tmp< Field< Type > >	snGrad () const
	Return patch-normal gradient. More...

virtual void	initEvaluate (const Pstream::commsTypes commsType)
	Initialise the evaluation of the patch field. More...

virtual void	evaluate (const Pstream::commsTypes commsType)
	Evaluate the patch field. More...

virtual tmp< Field< Type > >	valueInternalCoeffs (const tmp< scalarField > &) const
	Return the matrix diagonal coefficients corresponding to the. More...

virtual tmp< Field< Type > >	valueBoundaryCoeffs (const tmp< scalarField > &) const
	Return the matrix source coefficients corresponding to the. More...

virtual tmp< Field< Type > >	gradientInternalCoeffs (const scalarField &deltaCoeffs) const
	Return the matrix diagonal coefficients corresponding to the. More...

virtual tmp< Field< Type > >	gradientInternalCoeffs () const
	Return the matrix diagonal coefficients corresponding to the. More...

virtual tmp< Field< Type > >	gradientBoundaryCoeffs (const scalarField &deltaCoeffs) const
	Return the matrix source coefficients corresponding to the. More...

virtual tmp< Field< Type > >	gradientBoundaryCoeffs () const
	Return the matrix source coefficients corresponding to the. More...

Public Member Functions inherited from LduInterfaceField< Type >
	TypeName ("LduInterfaceField")
	Runtime type information. More...

	LduInterfaceField (const lduInterface &patch)
	Construct given coupled patch. More...

virtual	~LduInterfaceField ()
	Destructor. More...

virtual void	initInterfaceMatrixUpdate (Field< Type > &, const Field< Type > &, const scalarField &, const Pstream::commsTypes commsType) const
	Initialise neighbour matrix update. More...

Public Member Functions inherited from lduInterfaceField
	TypeName ("lduInterfaceField")
	Runtime type information. More...

	lduInterfaceField (const lduInterface &patch)
	Construct given coupled patch. More...

virtual	~lduInterfaceField ()
	Destructor. More...

const lduInterface &	interface () const
	Return the interface. More...

bool	updatedMatrix () const
	Whether matrix has been updated. More...

bool &	updatedMatrix ()
	Whether matrix has been updated. More...

virtual bool	ready () const
	Is all data available. More...

virtual void	initInterfaceMatrixUpdate (scalarField &, const scalarField &, const scalarField &, const direction, const Pstream::commsTypes commsType) const
	Initialise neighbour matrix update. More...

Public Member Functions inherited from fvPatchField< Type >
	TypeName ("fvPatchField")
	Runtime type information. More...

	declareRunTimeSelectionTable (tmp, fvPatchField, patch,(const fvPatch &p, const DimensionedField< Type, volMesh > &iF),(p, iF))

	declareRunTimeSelectionTable (tmp, fvPatchField, patchMapper,(const fvPatchField< Type > &ptf, const fvPatch &p, const DimensionedField< Type, volMesh > &iF, const fvPatchFieldMapper &m),(dynamic_cast< const fvPatchFieldType &>(ptf), p, iF, m))

	declareRunTimeSelectionTable (tmp, fvPatchField, dictionary,(const fvPatch &p, const DimensionedField< Type, volMesh > &iF, const dictionary &dict),(p, iF, dict))

	fvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &)
	Construct from patch and internal field. More...

	fvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const Type &value)
	Construct from patch, internal field and value. More...

	fvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const word &patchType)
	Construct from patch and internal field and patch type. More...

	fvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const Field< Type > &)
	Construct from patch and internal field and patch field. More...

	fvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const dictionary &, const bool valueRequired=true)
	Construct from patch, internal field and dictionary. More...

	fvPatchField (const fvPatchField< Type > &, const fvPatch &, const DimensionedField< Type, volMesh > &, const fvPatchFieldMapper &)
	Construct by mapping the given fvPatchField onto a new patch. More...

	fvPatchField (const fvPatchField< Type > &)
	Construct as copy. More...

	fvPatchField (const fvPatchField< Type > &, const DimensionedField< Type, volMesh > &)
	Construct as copy setting internal field reference. More...

virtual	~fvPatchField ()
	Destructor. More...

virtual bool	fixesValue () const
	Return true if this patch field fixes a value. More...

virtual bool	assignable () const
	Return true if the value of the patch field. More...

const objectRegistry &	db () const
	Return local objectRegistry. More...

const fvPatch &	patch () const
	Return patch. More...

const DimensionedField< Type, volMesh > &	internalField () const
	Return dimensioned internal field reference. More...

const Field< Type > &	primitiveField () const
	Return internal field reference. More...

const word &	patchType () const
	Optional patch type. More...

word &	patchType ()
	Optional patch type. More...

bool	updated () const
	Return true if the boundary condition has already been updated. More...

bool	manipulatedMatrix () const
	Return true if the matrix has already been manipulated. More...

virtual void	updateWeightedCoeffs (const scalarField &weights)
	Update the coefficients associated with the patch field. More...

virtual tmp< Field< Type > >	patchInternalField () const
	Return internal field next to patch as patch field. More...

virtual void	patchInternalField (Field< Type > &) const
	Return internal field next to patch as patch field. More...

virtual tmp< Field< Type > >	valueInternalCoeffs (const tmp< Field< scalar >> &) const
	Return the matrix diagonal coefficients corresponding to the. More...

virtual tmp< Field< Type > >	valueBoundaryCoeffs (const tmp< Field< scalar >> &) const
	Return the matrix source coefficients corresponding to the. More...

virtual void	manipulateMatrix (fvMatrix< Type > &matrix)
	Manipulate matrix. More...

virtual void	manipulateMatrix (fvMatrix< Type > &matrix, const scalarField &weights)
	Manipulate matrix with given weights. More...

template<class EntryType >
void	writeEntryIfDifferent (Ostream &os, const word &entryName, const EntryType &value1, const EntryType &value2) const
	Helper function to write the keyword and entry only if the. More...

void	check (const fvPatchField< Type > &) const
	Check fvPatchField<Type> against given fvPatchField<Type> More...

virtual void	operator= (const UList< Type > &)

virtual void	operator= (const fvPatchField< Type > &)

virtual void	operator+= (const fvPatchField< Type > &)

virtual void	operator-= (const fvPatchField< Type > &)

virtual void	operator*= (const fvPatchField< scalar > &)

virtual void	operator/= (const fvPatchField< scalar > &)

virtual void	operator+= (const Field< Type > &)

virtual void	operator-= (const Field< Type > &)

virtual void	operator*= (const Field< scalar > &)

virtual void	operator/= (const Field< scalar > &)

virtual void	operator= (const Type &)

virtual void	operator+= (const Type &)

virtual void	operator-= (const Type &)

virtual void	operator*= (const scalar)

virtual void	operator/= (const scalar)

virtual void	operator== (const fvPatchField< Type > &)

virtual void	operator== (const Field< Type > &)

virtual void	operator== (const Type &)

template<class Type2 >
Foam::tmp< Foam::fvPatchField< Type > >	NewCalculatedType (const fvPatchField< Type2 > &pf)

Public Member Functions inherited from Field< Type >
	Field ()
	Construct null. More...

	Field (const label)
	Construct given size. More...

	Field (const label, const Type &)
	Construct given size and initial value. More...

	Field (const label, const zero)
	Construct given size and initialed to zero. More...

	Field (const UList< Type > &)
	Construct as copy of a UList<Type> More...

	Field (const UIndirectList< Type > &)
	Construct as copy of a UIndirectList<Type> More...

	Field (const Xfer< List< Type >> &)
	Construct by transferring the List contents. More...

	Field (const UList< Type > &mapF, const labelUList &mapAddressing)
	Construct by 1 to 1 mapping from the given field. More...

	Field (const tmp< Field< Type >> &tmapF, const labelUList &mapAddressing)
	Construct by 1 to 1 mapping from the given tmp field. More...

	Field (const UList< Type > &mapF, const labelListList &mapAddressing, const scalarListList &weights)
	Construct by interpolative mapping from the given field. More...

	Field (const tmp< Field< Type >> &tmapF, const labelListList &mapAddressing, const scalarListList &weights)
	Construct by interpolative mapping from the given tmp field. More...

	Field (const UList< Type > &mapF, const FieldMapper &map, const bool applyFlip=true)
	Construct by mapping from the given field. More...

	Field (const UList< Type > &mapF, const FieldMapper &map, const Type &defaultValue, const bool applyFlip=true)
	Construct by mapping from the given field. More...

	Field (const UList< Type > &mapF, const FieldMapper &map, const UList< Type > &defaultValues, const bool applyFlip=true)
	Construct by mapping from the given field. More...

	Field (const tmp< Field< Type >> &tmapF, const FieldMapper &map, const bool applyFlip=true)
	Construct by mapping from the given tmp field. More...

	Field (const tmp< Field< Type >> &tmapF, const FieldMapper &map, const Type &defaultValue, const bool applyFlip=true)
	Construct by mapping from the given tmp field. Supplied uniform. More...

	Field (const tmp< Field< Type >> &tmapF, const FieldMapper &map, const UList< Type > &defaultValues, const bool applyFlip=true)
	Construct by mapping from the given tmp field. Supplied values. More...

	Field (const Field< Type > &)
	Construct as copy. More...

	Field (Field< Type > &, bool reuse)
	Construct as copy or re-use as specified. More...

	Field (const Xfer< Field< Type >> &)
	Construct by transferring the Field contents. More...

	Field (const tmp< Field< Type >> &)
	Construct as copy of tmp<Field> More...

	Field (Istream &)
	Construct from Istream. More...

	Field (const word &keyword, const dictionary &, const label size)
	Construct from a dictionary entry. More...

tmp< Field< Type > >	clone () const
	Clone. More...

void	map (const UList< Type > &mapF, const labelUList &mapAddressing)
	1 to 1 map from the given field More...

void	map (const tmp< Field< Type >> &tmapF, const labelUList &mapAddressing)
	1 to 1 map from the given tmp field More...

void	map (const UList< Type > &mapF, const labelListList &mapAddressing, const scalarListList &weights)
	Interpolative map from the given field. More...

void	map (const tmp< Field< Type >> &tmapF, const labelListList &mapAddressing, const scalarListList &weights)
	Interpolative map from the given tmp field. More...

void	map (const UList< Type > &mapF, const FieldMapper &map, const bool applyFlip=true)
	Map from the given field. More...

void	map (const tmp< Field< Type >> &tmapF, const FieldMapper &map, const bool applyFlip=true)
	Map from the given tmp field. More...

void	autoMap (const FieldMapper &map, const bool applyFlip=true)
	Map from self. More...

void	rmap (const UList< Type > &mapF, const labelUList &mapAddressing)
	1 to 1 reverse-map from the given field More...

void	rmap (const tmp< Field< Type >> &tmapF, const labelUList &mapAddressing)
	1 to 1 reverse-map from the given tmp field More...

void	rmap (const UList< Type > &mapF, const labelUList &mapAddressing, const UList< scalar > &weights)
	Interpolative reverse map from the given field. More...

void	rmap (const tmp< Field< Type >> &tmapF, const labelUList &mapAddressing, const UList< scalar > &weights)
	Interpolative reverse map from the given tmp field. More...

void	negate ()
	Negate this field. More...

tmp< Field< cmptType > >	component (const direction) const
	Return a component field of the field. More...

void	replace (const direction, const UList< cmptType > &)
	Replace a component field of the field. More...

void	replace (const direction, const tmp< Field< cmptType >> &)
	Replace a component field of the field. More...

void	replace (const direction, const cmptType &)
	Replace a component field of the field. More...

template<class VSForm >
VSForm	block (const label start) const

tmp< Field< Type > >	T () const
	Return the field transpose (only defined for second rank tensors) More...

void	writeEntry (const word &keyword, Ostream &os) const
	Write the field as a dictionary entry. More...

void	operator= (const Field< Type > &)

void	operator= (const UList< Type > &)

void	operator= (const SubField< Type > &)

void	operator= (const tmp< Field< Type >> &)

void	operator= (const Type &)

void	operator= (const zero)

template<class Form , class Cmpt , direction nCmpt>
void	operator= (const VectorSpace< Form, Cmpt, nCmpt > &)

void	operator+= (const UList< Type > &)

void	operator+= (const tmp< Field< Type >> &)

void	operator-= (const UList< Type > &)

void	operator-= (const tmp< Field< Type >> &)

void	operator*= (const UList< scalar > &)

void	operator*= (const tmp< Field< scalar >> &)

void	operator/= (const UList< scalar > &)

void	operator/= (const tmp< Field< scalar >> &)

void	operator+= (const Type &)

void	operator-= (const Type &)

void	operator*= (const scalar &)

void	operator/= (const scalar &)

template<class Type>
void	operator= (const tmp< Field > &rhs)

Public Member Functions inherited from refCount
int	count () const
	Return the current reference count. More...

bool	unique () const
	Return true if the reference count is zero. More...

void	operator++ ()
	Increment the reference count. More...

void	operator++ (int)
	Increment the reference count. More...

void	operator-- ()
	Decrement the reference count. More...

void	operator-- (int)
	Decrement the reference count. More...

Public Member Functions inherited from List< Type >
	List ()
	Null constructor. More...

	List (const label)
	Construct with given size. More...

	List (const label, const Type &)
	Construct with given size and value for all elements. More...

	List (const label, const zero)
	Construct with given size initializing all elements to zero. More...

	List (const List< Type > &)
	Copy constructor. More...

	List (const List< T2 > &)
	Copy constructor from list containing another type. More...

	List (const Xfer< List< Type >> &)
	Construct by transferring the parameter contents. More...

	List (List< Type > &, bool reuse)
	Construct as copy or re-use as specified. More...

	List (const UList< Type > &, const labelUList &mapAddressing)
	Construct as subset. More...

	List (InputIterator first, InputIterator last)
	Construct given start and end iterators. More...

	List (const FixedList< Type, Size > &)
	Construct as copy of FixedList<T, Size> More...

	List (const PtrList< Type > &)
	Construct as copy of PtrList<T> More...

	List (const SLList< Type > &)
	Construct as copy of SLList<T> More...

	List (const UIndirectList< Type > &)
	Construct as copy of UIndirectList<T> More...

	List (const BiIndirectList< Type > &)
	Construct as copy of BiIndirectList<T> More...

	List (std::initializer_list< Type >)
	Construct from an initializer list. More...

	List (Istream &)
	Construct from Istream. More...

label	size () const
	Return the number of elements in the UList. More...

autoPtr< List< Type > >	clone () const
	Clone. More...

	~List ()
	Destructor. More...

void	resize (const label)
	Alias for setSize(const label) More...

void	resize (const label, const Type &)
	Alias for setSize(const label, const T&) More...

void	setSize (const label)
	Reset size of List. More...

void	setSize (const label, const Type &)
	Reset size of List and value for new elements. More...

void	clear ()
	Clear the list, i.e. set size to zero. More...

void	append (const Type &)
	Append an element at the end of the list. More...

void	append (const UList< Type > &)
	Append a List at the end of this list. More...

void	append (const UIndirectList< Type > &)
	Append a UIndirectList at the end of this list. More...

void	transfer (List< Type > &)
	Transfer the contents of the argument List into this list. More...

void	transfer (DynamicList< Type, SizeInc, SizeMult, SizeDiv > &)
	Transfer the contents of the argument List into this list. More...

void	transfer (SortableList< Type > &)
	Transfer the contents of the argument List into this list. More...

Xfer< List< Type > >	xfer ()
	Transfer contents to the Xfer container. More...

Type &	newElmt (const label)
	Return subscript-checked element of UList. More...

void	shallowCopy (const UList< Type > &)=delete
	Disallow implicit shallowCopy. More...

void	operator= (const UList< Type > &)
	Assignment to UList operator. Takes linear time. More...

void	operator= (const List< Type > &)
	Assignment operator. Takes linear time. More...

void	operator= (const SLList< Type > &)
	Assignment to SLList operator. Takes linear time. More...

void	operator= (const UIndirectList< Type > &)
	Assignment to UIndirectList operator. Takes linear time. More...

void	operator= (const BiIndirectList< Type > &)
	Assignment to BiIndirectList operator. Takes linear time. More...

void	operator= (std::initializer_list< Type >)
	Assignment to an initializer list. More...

void	operator= (const Type &)
	Assignment of all entries to the given value. More...

void	operator= (const zero)
	Assignment of all entries to zero. More...

Public Member Functions inherited from UList< Type >
void	operator= (const Type &)
	Assignment of all entries to the given value. More...

void	operator= (const zero)
	Assignment of all entries to zero. More...

	UList ()
	Null constructor. More...

	UList (Type *__restrict__ v, label size)
	Construct from components. More...

label	fcIndex (const label i) const
	Return the forward circular index, i.e. the next index. More...

label	rcIndex (const label i) const
	Return the reverse circular index, i.e. the previous index. More...

std::streamsize	byteSize () const
	Return the binary size in number of characters of the UList. More...

const Type *	cdata () const
	Return a const pointer to the first data element,. More...

Type *	data ()
	Return a pointer to the first data element,. More...

Type &	first ()
	Return the first element of the list. More...

const Type &	first () const
	Return first element of the list. More...

Type &	last ()
	Return the last element of the list. More...

const Type &	last () const
	Return the last element of the list. More...

void	checkStart (const label start) const
	Check start is within valid range (0 ... size-1) More...

void	checkSize (const label size) const
	Check size is within valid range (0 ... size) More...

void	checkIndex (const label i) const
	Check index i is within valid range (0 ... size-1) More...

void	shallowCopy (const UList< Type > &)
	Copy the pointer held by the given UList. More...

void	deepCopy (const UList< Type > &)
	Copy elements of the given UList. More...

void	writeEntry (Ostream &) const
	Write the UList as a dictionary entry. More...

void	writeEntry (const word &keyword, Ostream &) const
	Write the UList as a dictionary entry with keyword. More...

Type &	operator[] (const label)
	Return element of UList. More...

const Type &	operator[] (const label) const
	Return element of constant UList. More...

const bool &	operator[] (const label i) const

	operator const Foam::List< Type > & () const
	Allow cast to a const List<T>&. More...

iterator	begin ()
	Return an iterator to begin traversing the UList. More...

const_iterator	begin () const
	Return const_iterator to begin traversing the constant UList. More...

iterator	end ()
	Return an iterator to end traversing the UList. More...

const_iterator	end () const
	Return const_iterator to end traversing the constant UList. More...

const_iterator	cbegin () const
	Return const_iterator to begin traversing the constant UList. More...

const_iterator	cend () const
	Return const_iterator to end traversing the constant UList. More...

reverse_iterator	rbegin ()
	Return reverse_iterator to begin reverse traversing the UList. More...

const_reverse_iterator	rbegin () const
	Return const_reverse_iterator to begin reverse traversing the UList. More...

reverse_iterator	rend ()
	Return reverse_iterator to end reverse traversing the UList. More...

const_reverse_iterator	rend () const
	Return const_reverse_iterator to end reverse traversing the UList. More...

const_reverse_iterator	crbegin () const
	Return const_reverse_iterator to begin reverse traversing the UList. More...

const_reverse_iterator	crend () const
	Return const_reverse_iterator to end reverse traversing the UList. More...

label	size () const
	Return the number of elements in the UList. More...

label	max_size () const
	Return size of the largest possible UList. More...

bool	empty () const
	Return true if the UList is empty (ie, size() is zero) More...

void	swap (UList< Type > &)
	Swap two ULists of the same type in constant time. More...

bool	operator== (const UList< Type > &) const
	Equality operation on ULists of the same type. More...

bool	operator!= (const UList< Type > &) const
	The opposite of the equality operation. Takes linear time. More...

bool	operator< (const UList< Type > &) const
	Compare two ULists lexicographically. Takes linear time. More...

bool	operator> (const UList< Type > &) const
	Compare two ULists lexicographically. Takes linear time. More...

bool	operator<= (const UList< Type > &) const
	Return true if !(a > b). Takes linear time. More...

bool	operator>= (const UList< Type > &) const
	Return true if !(a < b). Takes linear time. More...

Protected Attributes
autoPtr< Function1< Type > >	jumpTable_
	"jump" table More...

Protected Attributes inherited from fixedJumpFvPatchField< Type >
Field< Type >	jump_
	"jump" field More...

Additional Inherited Members
Public Types inherited from fvPatchField< Type >
typedef fvPatch	Patch

typedef calculatedFvPatchField< Type >	Calculated

Public Types inherited from Field< Type >
typedef pTraits< Type >::cmptType	cmptType
	Component type. More...

typedef SubField< Type >	subField
	Declare type of subField. More...

Public Types inherited from List< Type >
typedef SubList< Type >	subList
	Declare type of subList. More...

Public Types inherited from UList< Type >
typedef Type	value_type
	Type of values the UList contains. More...

typedef Type &	reference
	Type that can be used for storing into. More...

typedef const Type &	const_reference
	Type that can be used for storing into. More...

typedef label	difference_type
	The type that can represent the difference between any two. More...

typedef label	size_type
	The type that can represent the size of a UList. More...

typedef Type *	iterator
	Random access iterator for traversing UList. More...

typedef const Type *	const_iterator
	Random access iterator for traversing UList. More...

typedef Type *	reverse_iterator
	Reverse iterator for reverse traversal of UList. More...

typedef const Type *	const_reverse_iterator
	Reverse iterator for reverse traversal of constant UList. More...

Static Public Member Functions inherited from fvPatchField< Type >
static tmp< fvPatchField< Type > >	New (const word &, const fvPatch &, const DimensionedField< Type, volMesh > &)
	Return a pointer to a new patchField created on freestore given. More...

static tmp< fvPatchField< Type > >	New (const word &, const word &actualPatchType, const fvPatch &, const DimensionedField< Type, volMesh > &)
	Return a pointer to a new patchField created on freestore given. More...

static tmp< fvPatchField< Type > >	New (const fvPatchField< Type > &, const fvPatch &, const DimensionedField< Type, volMesh > &, const fvPatchFieldMapper &)
	Return a pointer to a new patchField created on freestore from. More...

static tmp< fvPatchField< Type > >	New (const fvPatch &, const DimensionedField< Type, volMesh > &, const dictionary &)
	Return a pointer to a new patchField created on freestore. More...

static tmp< fvPatchField< Type > >	NewCalculatedType (const fvPatch &)
	Return a pointer to a new calculatedFvPatchField created on. More...

template<class Type2 >
static tmp< fvPatchField< Type > >	NewCalculatedType (const fvPatchField< Type2 > &)
	Return a pointer to a new calculatedFvPatchField created on. More...

static const word &	calculatedType ()
	Return the type of the calculated for of fvPatchField. More...

Static Public Member Functions inherited from Field< Type >
static const Field< Type > &	null ()
	Return a null field. More...

template<class Type2 >
static tmp< Field< Type > >	NewCalculatedType (const Field< Type2 > &f)
	Return a pointer to a new calculatedFvPatchFieldField created on. More...

Static Public Member Functions inherited from List< Type >
static const List< Type > &	null ()
	Return a null List. More...

Static Public Member Functions inherited from UList< Type >
static const UList< Type > &	null ()
	Return a null UList. More...

Static Public Attributes inherited from fvPatchField< Type >
static int	disallowGenericFvPatchField
	Debug switch to disallow the use of genericFvPatchField. More...

Static Public Attributes inherited from Field< Type >
static const char *const	typeName

Protected Member Functions inherited from refCount
	refCount ()
	Construct null initializing count to 0. More...

Protected Member Functions inherited from List< Type >
void	size (const label)
	Override size to be inconsistent with allocated storage. More...

Detailed Description

template<class Type>
class Foam::uniformJumpFvPatchField< Type >

This boundary condition provides a jump condition, using the cyclic condition as a base. The jump is specified as a time-varying uniform value across the patch.

Usage

Property	Description	Required	Default value
`patchType`	underlying patch type should be `cyclic`	yes
`jumpTable`	jump value	yes

Example of the boundary condition specification:

    <patchName>
    {
        type            uniformJump;
        patchType       cyclic;
        jumpTable       constant 10;
    }

The above example shows the use of a fixed jump of '10'.

Note: The uniformValue entry is a Function1 type, able to describe time varying functions. The example above gives the usage for supplying a constant value.

The underlying patchType should be set to cyclic

See also: Foam::fixedJumpFvPatchField Foam::Function1Types

Source files

Definition at line 100 of file uniformJumpFvPatchField.H.

Constructor & Destructor Documentation

◆ uniformJumpFvPatchField() [1/5]

uniformJumpFvPatchField	(	const fvPatch &	p,
		const DimensionedField< Type, volMesh > &	iF
	)

Construct from patch and internal field.

Definition at line 32 of file uniformJumpFvPatchField.C.

Referenced by uniformJumpFvPatchField< Type >::clone(), and uniformJumpFvPatchField< Type >::uniformJumpFvPatchField().

Here is the caller graph for this function:

◆ uniformJumpFvPatchField() [2/5]

uniformJumpFvPatchField	(	const fvPatch &	p,
		const DimensionedField< Type, volMesh > &	iF,
		const dictionary &	dict
	)

Construct from patch, internal field and dictionary.

Definition at line 58 of file uniformJumpFvPatchField.C.

References dict, dictionary::found(), Foam::New(), List< Type >::size(), and uniformJumpFvPatchField< Type >::uniformJumpFvPatchField().

Here is the call graph for this function:

◆ uniformJumpFvPatchField() [3/5]

uniformJumpFvPatchField	(	const uniformJumpFvPatchField< Type > &	ptf,
		const fvPatch &	p,
		const DimensionedField< Type, volMesh > &	iF,
		const fvPatchFieldMapper &	mapper
	)

Construct by mapping given uniformJumpFvPatchField onto a.

new patch

Definition at line 44 of file uniformJumpFvPatchField.C.

References uniformJumpFvPatchField< Type >::uniformJumpFvPatchField().

Here is the call graph for this function:

◆ uniformJumpFvPatchField() [4/5]

uniformJumpFvPatchField ( const uniformJumpFvPatchField< Type > & ptf )

Construct as copy.

Definition at line 88 of file uniformJumpFvPatchField.C.

References uniformJumpFvPatchField< Type >::uniformJumpFvPatchField().

Here is the call graph for this function:

◆ uniformJumpFvPatchField() [5/5]

uniformJumpFvPatchField	(	const uniformJumpFvPatchField< Type > &	ptf,
		const DimensionedField< Type, volMesh > &	iF
	)

Construct as copy setting internal field reference.

Definition at line 99 of file uniformJumpFvPatchField.C.

Member Function Documentation

◆ TypeName()

TypeName ( "uniformJump" )

Runtime type information.

◆ clone() [1/2]

virtual tmp<fvPatchField<Type> > clone ( ) const

inlinevirtual

Construct and return a clone.

Reimplemented from fixedJumpFvPatchField< Type >.

Reimplemented in fanFvPatchField< Type >.

Definition at line 152 of file uniformJumpFvPatchField.H.

References uniformJumpFvPatchField< Type >::uniformJumpFvPatchField().

Here is the call graph for this function:

◆ clone() [2/2]

virtual tmp<fvPatchField<Type> > clone ( const DimensionedField< Type, volMesh > & iF ) const

inlinevirtual

Construct and return a clone setting internal field reference.

Reimplemented from fixedJumpFvPatchField< Type >.

Reimplemented in fanFvPatchField< Type >.

Definition at line 169 of file uniformJumpFvPatchField.H.

References uniformJumpFvPatchField< Type >::updateCoeffs(), and uniformJumpFvPatchField< Type >::write().

Here is the call graph for this function:

◆ updateCoeffs()

void updateCoeffs ( )

virtual

Update the coefficients.

Reimplemented from fvPatchField< Type >.

Reimplemented in fanFvPatchField< Type >.

Definition at line 112 of file uniformJumpFvPatchField.C.

Referenced by uniformJumpFvPatchField< Type >::clone().

Here is the caller graph for this function:

◆ write()

void write ( Ostream & os ) const

virtual

Write.

Reimplemented from fixedJumpFvPatchField< Type >.

Reimplemented in fanFvPatchField< Type >.

Definition at line 129 of file uniformJumpFvPatchField.C.

References Foam::blockMeshTools::write().

Referenced by uniformJumpFvPatchField< Type >::clone().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ jumpTable_

autoPtr<Function1<Type> > jumpTable_

protected

"jump" table

Definition at line 110 of file uniformJumpFvPatchField.H.

The documentation for this class was generated from the following files:

src/finiteVolume/fields/fvPatchFields/derived/uniformJump/uniformJumpFvPatchField.H
src/finiteVolume/fields/fvPatchFields/derived/uniformJump/uniformJumpFvPatchField.C

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

template<class Type> class Foam::uniformJumpFvPatchField< Type >

Constructor & Destructor Documentation

◆ uniformJumpFvPatchField() [1/5]

◆ uniformJumpFvPatchField() [2/5]

◆ uniformJumpFvPatchField() [3/5]

◆ uniformJumpFvPatchField() [4/5]

◆ uniformJumpFvPatchField() [5/5]

Member Function Documentation

◆ TypeName()

◆ clone() [1/2]

◆ clone() [2/2]

◆ updateCoeffs()

◆ write()

Member Data Documentation

◆ jumpTable_

template<class Type>
class Foam::uniformJumpFvPatchField< Type >