A NURBS 3D curve. More...

#include <NURBS3DCurve.H>

Inheritance diagram for NURBS3DCurve:

Collaboration diagram for NURBS3DCurve:

Public Member Functions
	NURBS3DCurve (const NURBSbasis &basis, const List< vector > &CPs, const List< scalar > &weights, const scalarField &u, const label nPts, const word name="NURBS3DCurve")
	Construct from control points, weights and basis order and parametric coordinates.
	NURBS3DCurve (const NURBSbasis &basis, const List< vector > &CPs, const List< scalar > &weights, const label nPts, const word name="NURBS3DCurve")
	Construct from control points, weights and basis order.
	NURBS3DCurve (const NURBSbasis &basis, const List< vector > &CPs, const label nPts, const word name="NURBS3DCurve")
	Construct from control points and basis order.
	NURBS3DCurve (const NURBS3DCurve &)
	Construct as copy.
	~NURBS3DCurve ()=default
	Destructor.
void	setNrm3DOrientation (const vector &givenNrm, const vector &givenTan)
	Take a given normal and use to determine if NURBS normals should be reversed. Computation taken from u = 0.
void	setNrm2DOrientation (const vector &givenNrm, const scalar zVal)
void	flipNrmOrientation ()
	Flip the orientation of the nrm.
void	setCPs (const List< vector > &CPs)
	Set CPs.
void	setWeights (const List< scalar > &weights)
	Set weights.
void	setName (const word &name)
	Set name.
void	buildCurve ()
	Build curve.
void	invert ()
	Invert CPs order and re-build curve.
void	insertKnot (const scalarField &oldKnots, const scalar uBar, const label kInsert)
	Insert a knot by re-computing the control points.
void	makeEquidistant (const label lenAcc=25, const label maxIter=10, const label spacingCorrInterval=-1, const scalar tolerance=1.e-5)
	Make curve points equidistant in cartesian space.
vector	curvePoint (const scalar u) const
	Curve point cartesian coordinates at ui.
scalar	findClosestCurvePoint (const vector &targetPoint, const label maxIter=1000, const scalar tolerance=1.e-13)
	Find curve point which is closest to given point using Newton-Raphson. Returns the param coordinate.
scalar	findClosestCurvePoint (const vector &targetPoint, const scalar initGuess, const label maxIter=1000, const scalar tolerance=1.e-13)
	Find curve point which is closest to given point using Newton-Raphson. Returns the param coordinate.
const vector	nrm3D (const vector &refTan, const scalar u) const
	Find the normal to the curve, with the option of forcing a z-plane.
const vector	nrm2D (const scalar zVal, const scalar u) const
scalarList	genEquidistant (const label nPts=100, const label lenAcc=25, const label maxIter=10, const label spacingCorrInterval=-1, const scalar tolerance=1.e-5)
	Generate points on the curve which are evenly spaced in cartesian coordinate distances.
bool	checkRange (const scalar u, const label CPI, const label degree) const
	Check if given parametric coordinate u and CP are linked.
bool	checkRange (const scalar u, const label CPI) const
scalar	length (const label uIStart, const label uIEnd) const
	Calculate Length from starting to ending indices via computational evaluation using trapezoid rule.
scalar	length (const scalar uStart, const scalar uEnd, const label nPts) const
	Calculate length from starting to ending parametric coordinates via computational evaluation using trapezoid rule.
scalar	length () const
	Calculate length for the entire curve length.
vector	curveDerivativeU (const scalar u) const
	Curve derivative wrt u at point ui.
vector	curveDerivativeUU (const scalar u) const
	Curve second derivative wrt u at point ui.
scalar	curveDerivativeCP (const scalar u, const label CPI)
	Curve derivative wrt b at point ui: scalar since dx/dX = dy/dY = dz/dZ.
vector	curveDerivativeWeight (const scalar u, const label CPI)
	Curve derivative wrt CPII at point u.
scalar	lengthDerivativeU (const scalar uStart, const scalar uEnd, const label nPts)
	Calculate length from starting to ending indices via computational evaluation using trapezoid rule.
const NURBSbasis &	getBasisFunction () const
	Get basis function.
const List< vector > &	getCPs () const
	Get CPs.
const List< scalar > &	getWeights () const
	Get weights.
const List< scalar > &	getParametricCoordinates () const
	Get parametric coordinates.
const word &	getName () const
	Get name.
label	nrmOrientation () const
	Return the nrm sgn relation to the u=0 nrm.
const vector &	givenInitNrm () const
	Return the initial normal given to compare to the Curve's normals.
void	write ()
	Write curve to file.
void	write (const word fileName)
void	write (const fileName dirName, const fileName fileName)
void	writeWParses ()
void	writeWParses (const word fileName)
void	writeWParses (const fileName dirName, const fileName fileName)
Public Member Functions inherited from Field< vector >
constexpr	Field () noexcept
	Default construct.
	Field (const label len)
	Construct given size.
	Field (const label len, const vector &val)
	Construct given size and initial value.
	Field (const label len, Foam::zero)
	Construct given size and initial values of zero.
	Field (Foam::one, const vector &val)
	Construct with length=1, copying the value as the only content.
	Field (Foam::one, vector &&val)
	Construct with length=1, moving the value as the only content.
	Field (Foam::one, Foam::zero)
	Construct with length=1, initializing content to zero.
	Field (const Field< vector > &fld)
	Copy construct.
	Field (const UList< vector > &list)
	Copy construct from UList<Type>.
	Field (const IndirectListBase< vector, Addr > &list)
	Copy construct from IndirectList.
	Field (Field< vector > &&fld) noexcept
	Move construct from Field.
	Field (List< vector > &&list) noexcept
	Move construct from List.
	Field (DynamicList< vector, SizeMin > &&list)
	Move construct from DynamicList.
	Field (const UList< vector > &mapF, const labelUList &mapAddressing)
	Construct by 1 to 1 mapping from the given field.
	Field (const tmp< Field< vector > > &tmapF, const labelUList &mapAddressing)
	Construct by 1 to 1 mapping from the given tmp field.
	Field (const UList< vector > &mapF, const labelListList &mapAddressing, const scalarListList &weights)
	Construct by interpolative mapping from the given field.
	Field (const tmp< Field< vector > > &tmapF, const labelListList &mapAddressing, const scalarListList &weights)
	Construct by interpolative mapping from the given tmp field.
	Field (const UList< vector > &mapF, const FieldMapper &map, const bool applyFlip=true)
	Construct by mapping from the given field.
	Field (const UList< vector > &mapF, const FieldMapper &map, const vector &defaultValue, const bool applyFlip=true)
	Construct by mapping from the given field.
	Field (const UList< vector > &mapF, const FieldMapper &map, const UList< vector > &defaultValues, const bool applyFlip=true)
	Construct by mapping from the given field.
	Field (const tmp< Field< vector > > &tmapF, const FieldMapper &map, const bool applyFlip=true)
	Construct by mapping from the given tmp field.
	Field (const tmp< Field< vector > > &tmapF, const FieldMapper &map, const vector &defaultValue, const bool applyFlip=true)
	Construct by mapping from the given tmp field. Uses supplied uniform value for unmapped items.
	Field (const tmp< Field< vector > > &tmapF, const FieldMapper &map, const UList< vector > &defaultValues, const bool applyFlip=true)
	Construct by mapping from the given tmp field. Uses supplied values for unmapped items.
	Field (Field< vector > &fld, bool reuse)
	Copy construct or re-use as specified.
	Field (const tmp< Field< vector > > &tfld)
	Copy or move construct from tmp.
	Field (Istream &is)
	Construct from Istream.
	Field (const entry &e, const label len)
	Construct from a dictionary (primitive) entry.
	Field (const word &key, const dictionary &dict, const label len, IOobjectOption::readOption readOpt=IOobjectOption::MUST_READ)
	Lookup of a primitive dictionary entry by (literal) name and assign its contents to this. The behaviour largely as described in assign():
tmp< Field< vector > >	clone () const
	Clone.
void	assign (const entry &e, const label len)
	Assign from a primitive dictionary entry with the following behaviour:
bool	assign (const word &key, const dictionary &dict, const label len, IOobjectOption::readOption readOpt=IOobjectOption::MUST_READ)
	Lookup a primitive dictionary entry by (literal) name and assign its contents to this (behaviour as described above).
void	map (const UList< vector > &mapF, const labelUList &mapAddressing)
	1 to 1 map from the given field
void	map (const tmp< Field< vector > > &tmapF, const labelUList &mapAddressing)
	1 to 1 map from the given tmp field
void	map (const UList< vector > &mapF, const labelListList &mapAddressing, const scalarListList &weights)
	Interpolative map from the given field.
void	map (const tmp< Field< vector > > &tmapF, const labelListList &mapAddressing, const scalarListList &weights)
	Interpolative map from the given tmp field.
void	map (const UList< vector > &mapF, const FieldMapper &map, const bool applyFlip=true)
	Map from the given field.
void	map (const tmp< Field< vector > > &tmapF, const FieldMapper &map, const bool applyFlip=true)
	Map from the given tmp field.
void	autoMap (const FieldMapper &map, const bool applyFlip=true)
	Map from self.
void	rmap (const UList< vector > &mapF, const labelUList &mapAddressing)
	1 to 1 reverse-map from the given field
void	rmap (const tmp< Field< vector > > &tmapF, const labelUList &mapAddressing)
	1 to 1 reverse-map from the given tmp field
void	rmap (const UList< vector > &mapF, const labelUList &mapAddressing, const UList< scalar > &weights)
	Interpolative reverse map from the given field.
void	rmap (const tmp< Field< vector > > &tmapF, const labelUList &mapAddressing, const UList< scalar > &weights)
	Interpolative reverse map from the given tmp field.
void	negate ()
	Inplace negate this field (negative).
void	normalise ()
	Inplace normalise this field. Generally a no-op except for vector fields.
tmp< Field< cmptType > >	component (const direction) const
	Return a component field of the field.
void	replace (const direction, const UList< cmptType > &)
	Replace a component field of the field.
void	replace (const direction, const tmp< Field< cmptType > > &)
	Replace a component field of the field.
void	replace (const direction, const cmptType &)
	Replace a component field of the field.
void	clamp_min (const vector &lower)
	Impose lower (floor) clamp on the field values (in-place).
void	clamp_min (const UList< vector > &lower)
	Impose lower (floor) clamp on the field values (in-place).
void	clamp_max (const vector &upper)
	Impose upper (ceiling) clamp on the field values (in-place).
void	clamp_max (const UList< vector > &upper)
	Impose upper (ceiling) clamp on the field values (in-place).
void	clamp_range (const vector &lower, const vector &upper)
	Clamp field values (in-place) to the specified range.
void	clamp_range (const MinMax< vector > &range)
	Clamp field values (in-place) to the specified range.
VSForm	block (const label start) const
tmp< Field< vector > >	T () const
	Return the field transpose (only defined for second rank tensors).
void	writeEntry (const word &keyword, Ostream &os) const
	Write the field as a dictionary entry.
SubField< vector >	slice (const label pos, label len=-1)
	Return SubField slice (non-const access) - no range checking.
const SubField< vector >	slice (const label pos, label len=-1) const
	Return SubField slice (const access) - no range checking.
SubField< vector >	slice (const labelRange &range)
	Return SubField slice (non-const access) - with range checking.
const SubField< vector >	slice (const labelRange &range) const
	Return SubField slice (const access) - with range checking.
void	operator= (const Field< vector > &)
	Copy assignment.
void	operator= (const tmp< Field< vector > > &)
void	operator= (const UList< vector > &rhs)
void	operator= (const SubField< vector > &rhs)
void	operator= (const IndirectListBase< vector, Addr > &rhs)
	Copy assign from IndirectList.
void	operator= (Field< vector > &&rhs)
	Move assignment.
void	operator= (List< vector > &&rhs)
void	operator= (DynamicList< vector, SizeMin > &&rhs)
void	operator= (const vector &val)
	Assign entries to the given value.
void	operator= (Foam::zero)
	Assign entries to zero.
void	operator= (const VectorSpace< Form, Cmpt, nCmpt > &)
void	operator+= (const UList< vector > &)
void	operator+= (const tmp< Field< vector > > &)
void	operator-= (const UList< vector > &)
void	operator-= (const tmp< Field< vector > > &)
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 vector &)
void	operator-= (const vector &)
void	operator*= (const scalar &)
void	operator/= (const scalar &)
	Field (const Expression::ListExpression< E > &expr)
	Construct from value expression.
void	operator= (const Expression::ListExpression< E > &expr)
	Assign values from expression.
void	operator= (const tmp< Field > &rhs)
void	normalise ()
void	normalise ()
void	normalise ()
	Inplace normalise (float) vector field.
void	normalise ()
	Inplace normalise (double) vector field.
Public Member Functions inherited from FieldBase
constexpr	FieldBase () noexcept
	Default construct.
Public Member Functions inherited from refCount
constexpr	refCount () noexcept
	Default construct, initializing count to 0.
int	use_count () const noexcept
	Return the current reference count.
bool	unique () const noexcept
	Return true if the reference count is zero.
void	operator++ () noexcept
	Increment the reference count.
void	operator++ (int) noexcept
	Increment the reference count.
void	operator-- () noexcept
	Decrement the reference count.
void	operator-- (int) noexcept
	Decrement the reference count.
Public Member Functions inherited from List< vector >
constexpr	List () noexcept
	Default construct.
	List (const label len)
	Construct with given size.
	List (const label len, const vector &val)
	Construct with given size and value for all elements.
	List (const label len, Foam::zero)
	Construct with given size initializing all elements to zero.
	List (Foam::one, const vector &val)
	Construct with length=1, copying the value as the only content.
	List (Foam::one, vector &&val)
	Construct with length=1, moving the value as the only content.
	List (Foam::one, Foam::zero)
	Construct with length=1, initializing content to zero.
	List (const List< vector > &list)
	Copy construct from list.
	List (const UList< vector > &list)
	Copy construct contents from list.
	List (List< vector > &list, bool reuse)
	Construct as copy or re-use as specified.
	List (const UList< vector > &list, const labelUList &indices)
	Copy construct subset of list.
	List (const UList< vector > &list, const FixedList< label, N > &indices)
	Copy construct subset of list.
	List (const FixedList< vector, N > &list)
	Construct as copy of FixedList<T, N>.
	List (const UPtrList< vector > &list)
	Construct as copy of UPtrList<T> content.
	List (const IndirectListBase< vector, Addr > &list)
	Construct as copy of IndirectList contents.
	List (std::initializer_list< vector > list)
	Construct from an initializer list.
	List (List< vector > &&list) noexcept
	Move construct from List.
	List (DynamicList< vector, SizeMin > &&list)
	Move construct from DynamicList.
	List (Istream &is)
	Construct from Istream.
autoPtr< List< vector > >	clone () const
	Clone.
	~List ()
	Destructor.
void	clear ()
	Clear the list, i.e. set size to zero.
void	resize (const label len)
	Adjust allocated size of list.
void	resize (const label len, const vector &val)
	Adjust allocated size of list and set val for new elements.
void	resize_copy (label count, const label len)
	Change allocated size of list, retaining the first count elements.
void	resize_fill (const label len, const vector &val)
	Adjust allocated size of list and set val for all elements.
void	resize_nocopy (const label len)
	Adjust allocated size of list without necessarily.
void	transfer (List< vector > &list)
	Transfer the contents of the argument List into this list and annul the argument list.
void	transfer (DynamicList< vector, SizeMin > &list)
	Transfer the contents of the argument List into this list and annul the argument list.
vector &	newElmt (const label i)
	Return subscript-checked element of UList and resizing the list if required.
vector &	emplace_back (Args &&... args)
	Construct an element at the end of the list, return reference to the new list element.
void	push_back (const vector &val)
	Append an element at the end of the list.
void	push_back (vector &&val)
	Move append an element at the end of the list.
void	push_back (const UList< vector > &list)
	Append a List to the end of this list.
void	push_back (const IndirectListBase< vector, Addr > &list)
	Append IndirectList contents at the end of this list.
label	push_uniq (const vector &val)
	Append an element if not already in the list.
void	pop_back (label n=1)
	Reduce size by 1 or more elements. Can be called on an empty list.
void	operator= (const UList< vector > &list)
	Assignment to UList operator. Takes linear time.
void	operator= (const List< vector > &list)
	Assignment operator. Takes linear time.
void	operator= (const IndirectListBase< vector, Addr > &list)
	Assignment from IndirectList. Takes linear time.
void	operator= (const FixedList< vector, N > &list)
	Copy assignment from FixedList.
void	operator= (std::initializer_list< vector > list)
	Assignment to an initializer list.
void	operator= (const vector &val)
	Assignment of all entries to the given value.
void	operator= (Foam::zero)
	Assignment of all entries to zero.
void	operator= (List< vector > &&list)
	Move assignment. Takes constant time.
void	operator= (DynamicList< vector, SizeMin > &&list)
	Move assignment. Takes constant time.
Istream &	readList (Istream &is)
	Read List from Istream, discarding contents of existing List.
void	shallowCopy (const UList< vector > &)=delete
	No shallowCopy permitted.
bool	set (const label i, bool val=true)
	A bitSet::set() method for a list of bool.
void	append (const vector &val)
	Append an element at the end of the list.
void	append (vector &&val)
	Move append an element at the end of the list.
void	append (const UList< vector > &list)
	Append a List to the end of this list.
void	append (const IndirectListBase< vector, Addr > &list)
	Append IndirectList contents at the end of this list.
label	appendUniq (const vector &val)
	Same as push_uniq().
void	setSize (label n)
	Alias for resize().
void	setSize (label n, const vector &val)
	Alias for resize().
	List (const Expression::ListExpression< E > &expr)
	Construct from value expression.
void	operator= (const Expression::ListExpression< E > &expr)
	Assign values from expression.
void	resize (const label len)
Public Member Functions inherited from UList< vector >
	UList (const UList< vector > &) noexcept=default
	Copy construct, shallow copy.
	UList (UList< vector > &&) noexcept=default
	Move construct, shallow copy.
UList< vector > &	operator= (const UList< vector > &)=delete
	No copy assignment (default: shallow copy).
UList< vector > &	operator= (UList< vector > &&) noexcept=default
	Move assignment, shallow copy.
constexpr	UList () noexcept
	Default construct, zero-sized and nullptr.
	UList (vector *__restrict__ ptr, const label len) noexcept
	Construct from components.
	UList (SubList< vector > &&) noexcept
	Move construct from a SubList, shallow copy.
label	fcIndex (const label i) const noexcept
	The forward circular index. The next index in the list which returns to the first at the end of the list.
label	rcIndex (const label i) const noexcept
	The reverse circular index. The previous index in the list which returns to the last at the beginning of the list.
const vector &	fcValue (const label i) const
	Return forward circular value (ie, next value in the list).
vector &	fcValue (const label i)
	Return forward circular value (ie, next value in the list).
const vector &	rcValue (const label i) const
	Return reverse circular value (ie, previous value in the list).
vector &	rcValue (const label i)
	Return reverse circular value (ie, previous value in the list).
const vector *	cdata () const noexcept
	Return pointer to the underlying array serving as data storage.
vector *	data () noexcept
	Return pointer to the underlying array serving as data storage.
const char *	cdata_bytes () const noexcept
	Return pointer to the underlying array serving as data storage,.
char *	data_bytes () noexcept
	Return pointer to the underlying array serving as data storage,.
vector &	front ()
	Access first element of the list, position [0].
const vector &	front () const
	Access first element of the list.
vector &	back ()
	Access last element of the list, position [size()-1].
const vector &	back () const
	Access last element of the list, position [size()-1].
std::streamsize	size_bytes () const noexcept
	Number of contiguous bytes for the List data.
std::streamsize	byteSize () const
	Number of contiguous bytes for the List data, runtime FatalError if type is not contiguous.
void	checkStart (const label start) const
	Check start is within valid range [0,size).
void	checkSize (const label size) const
	Check size is within valid range [0,size].
void	checkRange (const label start, const label len) const
	Check that start and length define a valid range.
void	checkIndex (const label i) const
	Check index is within valid range [0,size).
bool	uniform () const
	True if all entries have identical values, and list is non-empty.
bool	contains (const vector &val) const
	True if the value is contained in the list.
bool	contains (const vector &val, label pos, label len=-1) const
	Is the value contained in the list?
label	find (const vector &val) const
	Find index of the first occurrence of the value.
label	find (const vector &val, label pos, label len=-1) const
	Find index of the first occurrence of the value.
label	rfind (const vector &val, label pos=-1) const
	Find index of the last occurrence of the value.
void	moveFirst (const label i)
	Move element to the first position.
void	moveLast (const label i)
	Move element to the last position.
void	swapFirst (const label i)
	Swap element with the first element. Fatal on an empty list.
void	swapLast (const label i)
	Swap element with the last element. Fatal on an empty list.
void	shallowCopy (vector *__restrict__ ptr, const label len) noexcept
	Copy the pointer and size.
void	shallowCopy (std::nullptr_t) noexcept
	Copy nullptr and zero size.
void	shallowCopy (const UList< vector > &list) noexcept
	Copy the pointer and size held by the given UList.
void	deepCopy (const UList< vector > &list)
	Copy elements of the given UList. Sizes must match!
void	deepCopy (const IndirectListBase< vector, Addr > &list)
	Copy elements of the given indirect list. Sizes must match!
SubList< vector >	slice (const label pos, label len=-1)
	Return SubList slice (non-const access) - no range checking.
const SubList< vector >	slice (const label pos, label len=-1) const
	Return SubList slice (const access) - no range checking.
SubList< vector >	slice (const labelRange &range)
	Return SubList slice (non-const access) - with range checking.
const SubList< vector >	slice (const labelRange &range) const
	Return SubList slice (const access) - with range checking.
vector &	operator[] (const label i)
	Return element of UList.
const vector &	operator[] (const label i) const
	Return element of constant UList.
	operator const Foam::List< vector > & () const
	Allow cast to a const List<T>&.
void	operator= (const vector &val)
	Assignment of all entries to the given value.
void	operator= (Foam::zero)
	Assignment of all entries to zero.
iterator	begin () noexcept
	Return an iterator to begin traversing the UList.
iterator	end () noexcept
	Return an iterator to end traversing the UList.
iterator	begin (const label i) noexcept
	Return iterator at offset i from begin, clamped to [0,size] range.
const_iterator	cbegin () const noexcept
	Return const_iterator to begin traversing the constant UList.
const_iterator	cend () const noexcept
	Return const_iterator to end traversing the constant UList.
const_iterator	begin () const noexcept
	Return const_iterator to begin traversing the constant UList.
const_iterator	end () const noexcept
	Return const_iterator to end traversing the constant UList.
const_iterator	cbegin (const label i) const noexcept
	Return const_iterator at offset i from begin, clamped to [0,size] range.
const_iterator	begin (const label i) const noexcept
	Return const_iterator at offset i from begin, clamped to [0,size] range.
reverse_iterator	rbegin ()
	Return reverse_iterator to begin reverse traversing the UList.
reverse_iterator	rend ()
	Return reverse_iterator to end reverse traversing the UList.
const_reverse_iterator	crbegin () const
	Return const_reverse_iterator to begin reverse traversing the UList.
const_reverse_iterator	crend () const
	Return const_reverse_iterator to end reverse traversing the UList.
const_reverse_iterator	rbegin () const
	Return const_reverse_iterator to begin reverse traversing the UList.
const_reverse_iterator	rend () const
	Return const_reverse_iterator to end reverse traversing the UList.
bool	empty () const noexcept
	True if List is empty (ie, size() is zero).
label	size () const noexcept
	The number of elements in the container.
label	capacity () const noexcept
	Size of the underlying storage.
void	swap (UList< vector > &list) noexcept
	Swap content with another UList of the same type in constant time.
bool	operator== (const UList< vector > &list) const
	Equality operation on ULists of the same type.
bool	operator!= (const UList< vector > &list) const
	The opposite of the equality operation. Takes linear time.
bool	operator< (const UList< vector > &list) const
	Compare two ULists lexicographically. Takes linear time.
bool	operator> (const UList< vector > &list) const
	Compare two ULists lexicographically. Takes linear time.
bool	operator<= (const UList< vector > &list) const
	Return true if !(a > b). Takes linear time.
bool	operator>= (const UList< vector > &list) const
	Return true if !(a < b). Takes linear time.
Istream &	readList (Istream &is)
	Read List contents from Istream.
void	writeEntry (const word &keyword, Ostream &os) const
	Write the List as a dictionary entry with keyword.
Ostream &	writeList (Ostream &os, const label shortLen=0) const
	Write List, with line-breaks in ASCII when length exceeds shortLen.
bool	all () const
	True if all entries are 'true' or if the list is empty.
bool	any () const
	True if any entries are 'true'.
bool	none () const
	True if no entries are 'true'.
bool	test (const label i) const
	Test `bool` value at specified position, always false for out-of-range access.
bool	get (const label i) const
	Return `bool` value at specified position, always false for out-of-range access.
bool	unset (const label i)
	Unset the `bool` entry at specified position, always false for out-of-range access.
std::string_view	view () const
	Return a string_view of the charList. Content is non-modifiable.
vector &	first ()
	Access first element of the list, position [0].
const vector &	first () const
	Access first element of the list.
vector &	last ()
	Access last element of the list, position [size()-1].
const vector &	last () const
	Access last element of the list, position [size()-1].
bool	found (const vector &val, label pos=0) const
	Same as contains().
auto	expr () const
	Wrap value as expression.
void	operator= (const Expression::ListExpression< E > &expr)
	Assign values from expression.
	operator const Foam::List< vector > & () const
	Allow cast to a const List<T>&.

Additional Inherited Members
Public Types inherited from Field< vector >
typedef pTraits< vector >::cmptType	cmptType
	Component type.
typedef SubField< vector >	subField
	Declare type of subField.
Public Types inherited from List< vector >
typedef SubList< vector >	subList
	Declare type of subList.
Public Types inherited from UList< vector >
typedef vector	value_type
	The value type the list contains.
typedef vector *	pointer
	The pointer type for non-const access to value_type items.
typedef const vector *	const_pointer
	The pointer type for const access to value_type items.
typedef vector &	reference
	The type used for storing into value_type objects.
typedef const vector &	const_reference
	The type used for reading from constant value_type objects.
typedef vector *	iterator
	Random access iterator for traversing a UList.
typedef const vector *	const_iterator
	Random access iterator for traversing a UList.
typedef label	size_type
	The type to represent the size of a UList.
typedef label	difference_type
	The difference between iterator objects.
typedef std::reverse_iterator< iterator >	reverse_iterator
	Reverse iterator (non-const access).
typedef std::reverse_iterator< const_iterator >	const_reverse_iterator
	Reverse iterator (const access).
using	is_List
	Have unique tag.
Static Public Member Functions inherited from Field< vector >
static const Field< vector > &	null () noexcept
	Return a null Field (reference to a nullObject). Behaves like an empty Field.
static autoPtr< Field< vector > >	New (Istream &is)
	Return a pointer to a new Field created on freestore.
static tmp< Field< vector > >	NewCalculatedType (const Field< Type2 > &f)
	Return a pointer to a new calculatedFvPatchFieldField created on freestore without setting patchField values.
Static Public Member Functions inherited from FieldBase
static void	warnLocalBoundaryConsistencyCompat (const dictionary &)
	Warn about keyword changes for local boundary consistency checks.
static int	localBoundaryConsistency () noexcept
	Get flag for local boundary consistency checks.
static int	localBoundaryConsistency (int val) noexcept
	Set flag for local boundary consistency checks.
Static Public Member Functions inherited from List< vector >
static const List< vector > &	null () noexcept
	Return a null List (reference to a nullObject). Behaves like an empty List.
Static Public Member Functions inherited from UList< vector >
static const UList< vector > &	null () noexcept
	Return a null UList (reference to a nullObject). Behaves like an empty UList.
static constexpr label	max_size () noexcept
	The size of the largest possible UList.
Static Public Attributes inherited from FieldBase
static const char *const	typeName
	Typename for Field.
static bool	allowConstructFromLargerSize = false
	Permit read construct from a larger size.
static bool	unifiedGeometricField
	GeometricField with extra capacity for flattened boundary fields. Uses opt-switch "unifiedGeometricField".
static int	localBoundaryConsistency_
	Local boundary field consistency checks. Uses opt-switch "localBoundaryConsistency".
static scalar	localBoundaryTolerance_
	Tolerance for local boundary field consistency checks. Uses opt-switch "localBoundaryConsistency::tolerance".
Protected Member Functions inherited from UList< vector >
void	setAddressableSize (const label n) noexcept
	Set addressed size to be inconsistent with allocated storage.
void	size (const label n)
	Older name for setAddressableSize.
void	writeEntry (Ostream &os) const
	Write the UList with its compound type.
labelRange	validateRange (const labelRange &requestedRange) const
	Return a validated (start,size) subset range, which means that it always addresses a valid section of the list.
void	fill_uniform (const vector &val)
	Assign all entries to the given value.
void	fill_uniform (Foam::zero)
	Assign all entries to zero.

Detailed Description

A NURBS 3D curve.

Source files

Definition at line 51 of file NURBS3DCurve.H.

Constructor & Destructor Documentation

◆ NURBS3DCurve() [1/4]

NURBS3DCurve	(	const NURBSbasis &	basis,
		const List< vector > &	CPs,
		const List< scalar > &	weights,
		const scalarField &	u,
		const label	nPts,
		const word	name = "NURBS3DCurve" )

Construct from control points, weights and basis order and parametric coordinates.

Definition at line 202 of file NURBS3DCurve.C.

References buildCurve(), Foam::name(), and Foam::Zero.

Referenced by NURBS3DCurve().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ NURBS3DCurve() [2/4]

NURBS3DCurve	(	const NURBSbasis &	basis,
		const List< vector > &	CPs,
		const List< scalar > &	weights,
		const label	nPts,
		const word	name = "NURBS3DCurve" )

Construct from control points, weights and basis order.

Uniform coordinate distribution is implied

Definition at line 228 of file NURBS3DCurve.C.

References buildCurve(), Foam::name(), and Foam::Zero.

Here is the call graph for this function:

◆ NURBS3DCurve() [3/4]

NURBS3DCurve	(	const NURBSbasis &	basis,
		const List< vector > &	CPs,
		const label	nPts,
		const word	name = "NURBS3DCurve" )

Construct from control points and basis order.

Uniform coordinate distribution and unit weights are implied

Definition at line 254 of file NURBS3DCurve.C.

References buildCurve(), Foam::name(), UList< vector >::size(), and Foam::Zero.

Here is the call graph for this function:

◆ NURBS3DCurve() [4/4]

NURBS3DCurve ( const NURBS3DCurve & )

Construct as copy.

References NURBS3DCurve().

Here is the call graph for this function:

◆ ~NURBS3DCurve()

~NURBS3DCurve ( )

default

Destructor.

References Foam::name().

Here is the call graph for this function:

Member Function Documentation

◆ setNrm3DOrientation()

void setNrm3DOrientation	(	const vector &	givenNrm,
		const vector &	givenTan )

Take a given normal and use to determine if NURBS normals should be reversed. Computation taken from u = 0.

Definition at line 283 of file NURBS3DCurve.C.

References curveDerivativeU(), Foam::endl(), Foam::Info, Foam::tan(), and Foam::Zero.

Here is the call graph for this function:

◆ setNrm2DOrientation()

void setNrm2DOrientation	(	const vector &	givenNrm,
		const scalar	zVal )

Definition at line 309 of file NURBS3DCurve.C.

References curveDerivativeU(), Foam::endl(), Foam::Info, Foam::tan(), Vector< Cmpt >::x(), Vector< Cmpt >::y(), Vector< Cmpt >::z(), and Foam::Zero.

Here is the call graph for this function:

◆ flipNrmOrientation()

void flipNrmOrientation ( )

Flip the orientation of the nrm.

Definition at line 339 of file NURBS3DCurve.C.

◆ setCPs()

void setCPs ( const List< vector > & CPs )

Set CPs.

Definition at line 352 of file NURBS3DCurve.C.

◆ setWeights()

void setWeights ( const List< scalar > & weights )

Set weights.

Definition at line 358 of file NURBS3DCurve.C.

◆ setName()

void setName ( const word & name )

Set name.

Definition at line 364 of file NURBS3DCurve.C.

References Foam::name().

Here is the call graph for this function:

◆ buildCurve()

void buildCurve ( )

Build curve.

Definition at line 370 of file NURBS3DCurve.C.

References forAll, UList< vector >::operator[](), Foam::Zero, and VectorSpace< Form, Cmpt, Ncmpts >::zero.

Referenced by insertKnot(), invert(), makeEquidistant(), NURBS3DCurve(), NURBS3DCurve(), and NURBS3DCurve().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ invert()

void invert ( )

Invert CPs order and re-build curve.

Definition at line 401 of file NURBS3DCurve.C.

References buildCurve(), Foam::endl(), Foam::Info, and Foam::Zero.

Here is the call graph for this function:

◆ insertKnot()

void insertKnot	(	const scalarField &	oldKnots,
		const scalar	uBar,
		const label	kInsert )

Insert a knot by re-computing the control points.

The basis' insertKnot function must have beem called first to correctly provide the required info.

Definition at line 638 of file NURBS3DCurve.C.

References buildCurve(), UList< T >::size(), and Foam::Zero.

Here is the call graph for this function:

◆ makeEquidistant()

void makeEquidistant	(	const label	lenAcc = 25,
		const label	maxIter = 10,
		const label	spacingCorrInterval = -1,
		const scalar	tolerance = 1.e-5 )

Make curve points equidistant in cartesian space.

Definition at line 422 of file NURBS3DCurve.C.

References buildCurve().

Here is the call graph for this function:

◆ curvePoint()

vector curvePoint ( const scalar u ) const

Curve point cartesian coordinates at ui.

Definition at line 450 of file NURBS3DCurve.C.

References forAll, and Foam::Zero.

Referenced by findClosestCurvePoint(), and findClosestCurvePoint().

Here is the caller graph for this function:

◆ findClosestCurvePoint() [1/2]

scalar findClosestCurvePoint	(	const vector &	targetPoint,
		const label	maxIter = 1000,
		const scalar	tolerance = 1.e-13 )

Find curve point which is closest to given point using Newton-Raphson. Returns the param coordinate.

Definition at line 476 of file NURBS3DCurve.C.

References curveDerivativeU(), curveDerivativeUU(), curvePoint(), Foam::endl(), forAll, Foam::mag(), Foam::rhs(), UList< vector >::size(), and WarningInFunction.

Here is the call graph for this function:

◆ findClosestCurvePoint() [2/2]

scalar findClosestCurvePoint	(	const vector &	targetPoint,
		const scalar	initGuess,
		const label	maxIter = 1000,
		const scalar	tolerance = 1.e-13 )

Find curve point which is closest to given point using Newton-Raphson. Returns the param coordinate.

Definition at line 546 of file NURBS3DCurve.C.

References curveDerivativeU(), curveDerivativeUU(), curvePoint(), Foam::endl(), Foam::mag(), Foam::rhs(), and WarningInFunction.

Here is the call graph for this function:

◆ nrm3D()

const vector nrm3D	(	const vector &	refTan,
		const scalar	u ) const

Find the normal to the curve, with the option of forcing a z-plane.

Definition at line 605 of file NURBS3DCurve.C.

References curveDerivativeU(), Vector< Cmpt >::normalise(), and Foam::Zero.

Here is the call graph for this function:

◆ nrm2D()

const vector nrm2D	(	const scalar	zVal,
		const scalar	u ) const

Definition at line 624 of file NURBS3DCurve.C.

References curveDerivativeU(), Foam::mag(), Foam::tan(), Vector< Cmpt >::x(), Vector< Cmpt >::y(), Vector< Cmpt >::z(), and Foam::Zero.

Here is the call graph for this function:

◆ genEquidistant()

scalarList genEquidistant	(	const label	nPts = 100,
		const label	lenAcc = 25,
		const label	maxIter = 10,
		const label	spacingCorrInterval = -1,
		const scalar	tolerance = 1.e-5 )

Generate points on the curve which are evenly spaced in cartesian coordinate distances.

Definition at line 680 of file NURBS3DCurve.C.

References U, and Foam::Zero.

◆ checkRange() [1/2]

bool checkRange	(	const scalar	u,
		const label	CPI,
		const label	degree ) const

Check if given parametric coordinate u and CP are linked.

Definition at line 711 of file NURBS3DCurve.C.

◆ checkRange() [2/2]

bool checkRange	(	const scalar	u,
		const label	CPI ) const

Definition at line 722 of file NURBS3DCurve.C.

◆ length() [1/3]

scalar length	(	const label	uIStart,
		const label	uIEnd ) const

Calculate Length from starting to ending indices via computational evaluation using trapezoid rule.

Definition at line 729 of file NURBS3DCurve.C.

References curveDerivativeU(), forAll, length(), length(), Foam::mag(), and Foam::Zero.

Referenced by length(), and length().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ length() [2/3]

scalar length	(	const scalar	uStart,
		const scalar	uEnd,
		const label	nPts ) const

Calculate length from starting to ending parametric coordinates via computational evaluation using trapezoid rule.

Definition at line 754 of file NURBS3DCurve.C.

References curveDerivativeU(), forAll, length(), length(), Foam::mag(), and Foam::Zero.

Here is the call graph for this function:

◆ length() [3/3]

scalar length ( ) const

Calculate length for the entire curve length.

Definition at line 785 of file NURBS3DCurve.C.

References length().

Referenced by length(), length(), and length().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ curveDerivativeU()

vector curveDerivativeU ( const scalar u ) const

Curve derivative wrt u at point ui.

Definition at line 793 of file NURBS3DCurve.C.

References forAll, and Foam::Zero.

Referenced by findClosestCurvePoint(), findClosestCurvePoint(), length(), length(), lengthDerivativeU(), nrm2D(), nrm3D(), setNrm2DOrientation(), and setNrm3DOrientation().

Here is the caller graph for this function:

◆ curveDerivativeUU()

vector curveDerivativeUU ( const scalar u ) const

Curve second derivative wrt u at point ui.

Definition at line 818 of file NURBS3DCurve.C.

References forAll, and Foam::Zero.

Referenced by findClosestCurvePoint(), findClosestCurvePoint(), and lengthDerivativeU().

Here is the caller graph for this function:

◆ curveDerivativeCP()

scalar curveDerivativeCP	(	const scalar	u,
		const label	CPI )

Curve derivative wrt b at point ui: scalar since dx/dX = dy/dY = dz/dZ.

Definition at line 856 of file NURBS3DCurve.C.

References forAll, and Foam::Zero.

◆ curveDerivativeWeight()

vector curveDerivativeWeight	(	const scalar	u,
		const label	CPI )

Curve derivative wrt CPII at point u.

Definition at line 878 of file NURBS3DCurve.C.

References forAll, and Foam::Zero.

◆ lengthDerivativeU()

scalar lengthDerivativeU	(	const scalar	uStart,
		const scalar	uEnd,
		const label	nPts )

Calculate length from starting to ending indices via computational evaluation using trapezoid rule.

Definition at line 904 of file NURBS3DCurve.C.

References curveDerivativeU(), curveDerivativeUU(), forAll, Foam::mag(), and Foam::Zero.

Here is the call graph for this function:

◆ getBasisFunction()

const NURBSbasis & getBasisFunction ( ) const

inline

Get basis function.

Definition at line 384 of file NURBS3DCurve.H.

◆ getCPs()

const List< vector > & getCPs ( ) const

inline

Get CPs.

Definition at line 392 of file NURBS3DCurve.H.

◆ getWeights()

const List< scalar > & getWeights ( ) const

inline

Get weights.

Definition at line 400 of file NURBS3DCurve.H.

◆ getParametricCoordinates()

const List< scalar > & getParametricCoordinates ( ) const

inline

Get parametric coordinates.

Definition at line 408 of file NURBS3DCurve.H.

◆ getName()

const word & getName ( ) const

inline

Get name.

Definition at line 416 of file NURBS3DCurve.H.

◆ nrmOrientation()

label nrmOrientation ( ) const

inline

Return the nrm sgn relation to the u=0 nrm.

Definition at line 424 of file NURBS3DCurve.H.

◆ givenInitNrm()

const vector & givenInitNrm ( ) const

inline

Return the initial normal given to compare to the Curve's normals.

Definition at line 432 of file NURBS3DCurve.H.

◆ write() [1/3]

void write ( )

Write curve to file.

Definition at line 947 of file NURBS3DCurve.C.

References write().

Referenced by write().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ write() [2/3]

void write ( const word fileName )

Definition at line 953 of file NURBS3DCurve.C.

References Foam::endl(), field(), forAll, and UPstream::master().

Here is the call graph for this function:

◆ write() [3/3]

void write	(	const fileName	dirName,
		const fileName	fileName )

Definition at line 1002 of file NURBS3DCurve.C.

References Foam::endl(), field(), forAll, and UPstream::master().

Here is the call graph for this function:

◆ writeWParses() [1/3]

void writeWParses ( )

Definition at line 1052 of file NURBS3DCurve.C.

References writeWParses().

Referenced by writeWParses().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ writeWParses() [2/3]

void writeWParses ( const word fileName )

Definition at line 1058 of file NURBS3DCurve.C.

References Foam::endl(), field(), forAll, and UPstream::master().

Here is the call graph for this function:

◆ writeWParses() [3/3]

void writeWParses	(	const fileName	dirName,
		const fileName	fileName )

Definition at line 1109 of file NURBS3DCurve.C.

References Foam::endl(), field(), forAll, and UPstream::master().

Here is the call graph for this function:

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

src/optimisation/adjointOptimisation/adjoint/parameterization/NURBS/NURBS3DCurve/NURBS3DCurve.H
src/optimisation/adjointOptimisation/adjoint/parameterization/NURBS/NURBS3DCurve/NURBS3DCurve.C

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ NURBS3DCurve() [1/4]

◆ NURBS3DCurve() [2/4]

◆ NURBS3DCurve() [3/4]

◆ NURBS3DCurve() [4/4]

◆ ~NURBS3DCurve()

Member Function Documentation

◆ setNrm3DOrientation()

◆ setNrm2DOrientation()

◆ flipNrmOrientation()

◆ setCPs()

◆ setWeights()

◆ setName()

◆ buildCurve()

◆ invert()

◆ insertKnot()

◆ makeEquidistant()

◆ curvePoint()

◆ findClosestCurvePoint() [1/2]

◆ findClosestCurvePoint() [2/2]

◆ nrm3D()

◆ nrm2D()

◆ genEquidistant()

◆ checkRange() [1/2]

◆ checkRange() [2/2]

◆ length() [1/3]

◆ length() [2/3]

◆ length() [3/3]

◆ curveDerivativeU()

◆ curveDerivativeUU()

◆ curveDerivativeCP()

◆ curveDerivativeWeight()

◆ lengthDerivativeU()

◆ getBasisFunction()

◆ getCPs()

◆ getWeights()

◆ getParametricCoordinates()

◆ getName()

◆ nrmOrientation()

◆ givenInitNrm()

◆ write() [1/3]

◆ write() [2/3]

◆ write() [3/3]

◆ writeWParses() [1/3]

◆ writeWParses() [2/3]

◆ writeWParses() [3/3]